# azpipeline
[](https://pypi.python.org/pypi/azpipeline/)
[](https://pypi.python.org/pypi/azpipeline/)
[](https://pypi.python.org/pypi/azpipeline/)
---
**Documentation**: [https://azpipeline.readthedocs.io/en/latest/](https://azpipeline.readthedocs.io/en/latest/)
**Source Code**: [https://github.com/nidhaloff/azpipeline](https://github.com/nidhaloff/azpipeline)
**PyPI**: [https://pypi.org/project/azpipeline/](https://pypi.org/project/azpipeline/)
---
Interact with azure pipelines using python
## Installation
```sh
pip install azpipeline
```
## Development
* Clone this repository
* Requirements:
* [Poetry](https://python-poetry.org/)
* Python 3.7+
* Create a virtual environment and install the dependencies
```sh
poetry install
```
* Activate the virtual environment
```sh
poetry shell
```
### Testing
```sh
pytest
```
### Documentation
The documentation is automatically generated from the content of the [docs directory](./docs) and from the docstrings
of the public signatures of the source code. The documentation is updated and published as a [Github project page
](https://pages.github.com/) automatically as part each release.
### Releasing
Trigger the [Draft release workflow](https://github.com/nidhaloff/azpipeline/actions/workflows/draft_release.yml)
(press _Run workflow_). This will update the changelog & version and create a GitHub release which is in _Draft_ state.
Find the draft release from the
[GitHub releases](https://github.com/nidhaloff/azpipeline/releases) and publish it. When
a release is published, it'll trigger [release](https://github.com/nidhaloff/azpipeline/blob/master/.github/workflows/release.yml) workflow which creates PyPI
release and deploys updated documentation.
### Pre-commit
Pre-commit hooks run all the auto-formatters (e.g. `black`, `isort`), linters (e.g. `mypy`, `flake8`), and other quality
checks to make sure the changeset is in good shape before a commit/push happens.
You can install the hooks with (runs for each commit):
```sh
pre-commit install
```
Or if you want them to run only for each push:
```sh
pre-commit install -t pre-push
```
Or if you want e.g. want to run all checks manually for all files:
```sh
pre-commit run --all-files
```
Raw data
{
"_id": null,
"home_page": "https://nidhaloff.github.io/azpipeline",
"name": "azpipeline",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7.1,<4.0",
"maintainer_email": "",
"keywords": "",
"author": "Nidhal Baccouri",
"author_email": "nidhalbacc@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/1f/25/11eb92c13ecf2524c1e3394d0450e3bd5472dfa4672f8e2adab84216d323/azpipeline-0.0.1.tar.gz",
"platform": null,
"description": "# azpipeline\n\n[](https://pypi.python.org/pypi/azpipeline/)\n[](https://pypi.python.org/pypi/azpipeline/)\n[](https://pypi.python.org/pypi/azpipeline/)\n\n\n---\n\n**Documentation**: [https://azpipeline.readthedocs.io/en/latest/](https://azpipeline.readthedocs.io/en/latest/)\n\n**Source Code**: [https://github.com/nidhaloff/azpipeline](https://github.com/nidhaloff/azpipeline)\n\n**PyPI**: [https://pypi.org/project/azpipeline/](https://pypi.org/project/azpipeline/)\n\n---\n\nInteract with azure pipelines using python\n\n## Installation\n\n```sh\npip install azpipeline\n```\n\n## Development\n\n* Clone this repository\n* Requirements:\n * [Poetry](https://python-poetry.org/)\n * Python 3.7+\n* Create a virtual environment and install the dependencies\n\n```sh\npoetry install\n```\n\n* Activate the virtual environment\n\n```sh\npoetry shell\n```\n\n### Testing\n\n```sh\npytest\n```\n\n### Documentation\n\nThe documentation is automatically generated from the content of the [docs directory](./docs) and from the docstrings\n of the public signatures of the source code. The documentation is updated and published as a [Github project page\n ](https://pages.github.com/) automatically as part each release.\n\n### Releasing\n\nTrigger the [Draft release workflow](https://github.com/nidhaloff/azpipeline/actions/workflows/draft_release.yml)\n(press _Run workflow_). This will update the changelog & version and create a GitHub release which is in _Draft_ state.\n\nFind the draft release from the\n[GitHub releases](https://github.com/nidhaloff/azpipeline/releases) and publish it. When\n a release is published, it'll trigger [release](https://github.com/nidhaloff/azpipeline/blob/master/.github/workflows/release.yml) workflow which creates PyPI\n release and deploys updated documentation.\n\n### Pre-commit\n\nPre-commit hooks run all the auto-formatters (e.g. `black`, `isort`), linters (e.g. `mypy`, `flake8`), and other quality\n checks to make sure the changeset is in good shape before a commit/push happens.\n\nYou can install the hooks with (runs for each commit):\n\n```sh\npre-commit install\n```\n\nOr if you want them to run only for each push:\n\n```sh\npre-commit install -t pre-push\n```\n\nOr if you want e.g. want to run all checks manually for all files:\n\n```sh\npre-commit run --all-files\n```\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Interact with azure pipelines using python",
"version": "0.0.1",
"project_urls": {
"Documentation": "https://nidhaloff.github.io/azpipeline",
"Homepage": "https://nidhaloff.github.io/azpipeline",
"Repository": "https://github.com/nidhaloff/azpipeline"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "8bcf960cd8efd3d06b3a3597a9267e68cb568717f734487dfe087c9371d8e609",
"md5": "783fd98a4326a691b6cf7d0e9f9a6d08",
"sha256": "cc1da10998d4b30e0e3d610e15a06454b919be9b62d783d7fe75e0dfde837ebd"
},
"downloads": -1,
"filename": "azpipeline-0.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "783fd98a4326a691b6cf7d0e9f9a6d08",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7.1,<4.0",
"size": 6844,
"upload_time": "2023-08-09T21:46:35",
"upload_time_iso_8601": "2023-08-09T21:46:35.378294Z",
"url": "https://files.pythonhosted.org/packages/8b/cf/960cd8efd3d06b3a3597a9267e68cb568717f734487dfe087c9371d8e609/azpipeline-0.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "1f2511eb92c13ecf2524c1e3394d0450e3bd5472dfa4672f8e2adab84216d323",
"md5": "736e7241d9f6e10a6e38ff7dd5087c3f",
"sha256": "9164f38122f4dd7aa90e579c58cc423a3f60a8424edfe591d9126d29c1a0092c"
},
"downloads": -1,
"filename": "azpipeline-0.0.1.tar.gz",
"has_sig": false,
"md5_digest": "736e7241d9f6e10a6e38ff7dd5087c3f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7.1,<4.0",
"size": 6742,
"upload_time": "2023-08-09T21:46:36",
"upload_time_iso_8601": "2023-08-09T21:46:36.904985Z",
"url": "https://files.pythonhosted.org/packages/1f/25/11eb92c13ecf2524c1e3394d0450e3bd5472dfa4672f8e2adab84216d323/azpipeline-0.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-08-09 21:46:36",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "nidhaloff",
"github_project": "azpipeline",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "azpipeline"
}
JSON
