auris_tools 0.0.1__tar.gz → 0.0.2__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Potentially problematic release.


This version of auris_tools might be problematic. Click here for more details.

@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.3
2
2
  Name: auris_tools
3
- Version: 0.0.1
3
+ Version: 0.0.2
4
4
  Summary: The swiss knife tools to coordinates cloud frameworks with an easy for Auris platforms
5
5
  Author: Antonio Senra
6
6
  Author-email: acsenrafilho@gmail.com
@@ -19,6 +19,12 @@ Description-Content-Type: text/markdown
19
19
 
20
20
  # auris-tools
21
21
 
22
+ [![PyPI version](https://img.shields.io/pypi/v/auris-tools.svg)](https://pypi.org/project/auris-tools/)
23
+ [![Documentation Status](https://readthedocs.org/projects/auris-tools/badge/?version=latest)](https://auris-tools.readthedocs.io/en/latest/?badge=latest)
24
+ [![CI for Develop Branch](https://github.com/AurisAASI/auris-tools/actions/workflows/ci_develop.yml/badge.svg?branch=develop)](https://github.com/AurisAASI/auris-tools/actions/workflows/ci_develop.yml)
25
+ [![CI for Develop Branch](https://github.com/AurisAASI/auris-tools/actions/workflows/ci_develop.yml/badge.svg?branch=main)](https://github.com/AurisAASI/auris-tools/actions/workflows/ci_develop.yml)
26
+ [![codecov](https://codecov.io/gh/AurisAASI/auris-tools/graph/badge.svg?token=08891W8HP2)](https://codecov.io/gh/AurisAASI/auris-tools)
27
+
22
28
  The swiss knife tools to coordinates cloud frameworks with an easy for Auris platforms
23
29
 
24
30
  ## Installation
@@ -65,12 +71,27 @@ The main classes and modules are organized as follows:
65
71
  ```bash
66
72
  task test
67
73
  ```
68
- - **Run linter (ruff):**
74
+ - **Run linter (blue and isort):**
69
75
  ```bash
70
76
  task lint
71
77
  ```
72
78
 
73
79
  Test coverage and linting are enforced in CI. Make sure all tests pass and code is linted before submitting a PR.
74
80
 
81
+ ## Documentation
82
+
83
+ We use MkDocs with Material theme for our documentation:
84
+
85
+ - **Run documentation server locally:**
86
+ ```bash
87
+ task docs
88
+ ```
89
+ - **Build documentation:**
90
+ ```bash
91
+ task docs-build
92
+ ```
93
+
94
+ The documentation is automatically published to Read the Docs when changes are pushed to the main branch.
95
+
75
96
  ---
76
97
 
@@ -1,5 +1,11 @@
1
1
  # auris-tools
2
2
 
3
+ [![PyPI version](https://img.shields.io/pypi/v/auris-tools.svg)](https://pypi.org/project/auris-tools/)
4
+ [![Documentation Status](https://readthedocs.org/projects/auris-tools/badge/?version=latest)](https://auris-tools.readthedocs.io/en/latest/?badge=latest)
5
+ [![CI for Develop Branch](https://github.com/AurisAASI/auris-tools/actions/workflows/ci_develop.yml/badge.svg?branch=develop)](https://github.com/AurisAASI/auris-tools/actions/workflows/ci_develop.yml)
6
+ [![CI for Develop Branch](https://github.com/AurisAASI/auris-tools/actions/workflows/ci_develop.yml/badge.svg?branch=main)](https://github.com/AurisAASI/auris-tools/actions/workflows/ci_develop.yml)
7
+ [![codecov](https://codecov.io/gh/AurisAASI/auris-tools/graph/badge.svg?token=08891W8HP2)](https://codecov.io/gh/AurisAASI/auris-tools)
8
+
3
9
  The swiss knife tools to coordinates cloud frameworks with an easy for Auris platforms
4
10
 
5
11
  ## Installation
@@ -46,11 +52,26 @@ The main classes and modules are organized as follows:
46
52
  ```bash
47
53
  task test
48
54
  ```
49
- - **Run linter (ruff):**
55
+ - **Run linter (blue and isort):**
50
56
  ```bash
51
57
  task lint
52
58
  ```
53
59
 
54
60
  Test coverage and linting are enforced in CI. Make sure all tests pass and code is linted before submitting a PR.
55
61
 
62
+ ## Documentation
63
+
64
+ We use MkDocs with Material theme for our documentation:
65
+
66
+ - **Run documentation server locally:**
67
+ ```bash
68
+ task docs
69
+ ```
70
+ - **Build documentation:**
71
+ ```bash
72
+ task docs-build
73
+ ```
74
+
75
+ The documentation is automatically published to Read the Docs when changes are pushed to the main branch.
76
+
56
77
  ---
@@ -1,6 +1,6 @@
1
1
  [project]
2
2
  name = "auris_tools"
3
- version = "0.0.1"
3
+ version = "0.0.2"
4
4
  description = "The swiss knife tools to coordinates cloud frameworks with an easy for Auris platforms"
5
5
  authors = [
6
6
  {name = "Antonio Senra",email = "acsenrafilho@gmail.com"}
@@ -28,6 +28,14 @@ pytest-cov = "^7.0.0"
28
28
  blue = "^0.9.1"
29
29
  taskipy = "^1.14.1"
30
30
 
31
+ [tool.poetry.group.docs.dependencies]
32
+ mkdocs = "^1.5.0"
33
+ mkdocs-material = "^9.4.0"
34
+ mkdocstrings = "^0.23.0"
35
+ mkdocstrings-python = "^1.6.0"
36
+ mkdocs-autorefs = "^0.5.0"
37
+ griffe = "^0.36.0"
38
+
31
39
  [tool.isort]
32
40
  profile = "black"
33
41
  line_length = 79
@@ -38,6 +46,8 @@ lint-check = "blue --check . && isort --check ."
38
46
  pre_test="task lint-check"
39
47
  test = "pytest -s -x --cov=auris_tools -vv --disable-warnings"
40
48
  post_test = "coverage html"
49
+ docs = "mkdocs serve"
50
+ docs-build = "mkdocs build"
41
51
 
42
52
  [tool.coverage.run]
43
53
  source = ["auris_tools"]