| Name | encommon JSON |
| Version |
0.20.5
JSON |
| download |
| home_page | None |
| Summary | Enasis Network Common Library |
| upload_time | 2024-10-20 11:23:37 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.11 |
| license | MIT |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Enasis Network Common Library
> :warning: This project has not released its first major version.
Common classes and functions used in various public and private projects.
<a href="https://pypi.org/project/encommon"><img src="https://enasisnetwork.github.io/encommon/badges/pypi.png"></a><br>
<a href="https://enasisnetwork.github.io/encommon/validate/flake8.txt"><img src="https://enasisnetwork.github.io/encommon/badges/flake8.png"></a><br>
<a href="https://enasisnetwork.github.io/encommon/validate/pylint.txt"><img src="https://enasisnetwork.github.io/encommon/badges/pylint.png"></a><br>
<a href="https://enasisnetwork.github.io/encommon/validate/ruff.txt"><img src="https://enasisnetwork.github.io/encommon/badges/ruff.png"></a><br>
<a href="https://enasisnetwork.github.io/encommon/validate/mypy.txt"><img src="https://enasisnetwork.github.io/encommon/badges/mypy.png"></a><br>
<a href="https://enasisnetwork.github.io/encommon/validate/yamllint.txt"><img src="https://enasisnetwork.github.io/encommon/badges/yamllint.png"></a><br>
<a href="https://enasisnetwork.github.io/encommon/validate/pytest.txt"><img src="https://enasisnetwork.github.io/encommon/badges/pytest.png"></a><br>
<a href="https://enasisnetwork.github.io/encommon/validate/coverage.txt"><img src="https://enasisnetwork.github.io/encommon/badges/coverage.png"></a><br>
<a href="https://enasisnetwork.github.io/encommon/validate/sphinx.txt"><img src="https://enasisnetwork.github.io/encommon/badges/sphinx.png"></a><br>
## Documentation
Read [project documentation](https://enasisnetwork.github.io/encommon/sphinx)
built using the [Sphinx](https://www.sphinx-doc.org/) project.
Should you venture into the sections below you will be able to use the
`sphinx` recipe to build documention in the `sphinx/html` directory.
## Projects using library
- [Enasis Network Remote Connect](https://github.com/enasisnetwork/enconnect)
- [Enasis Network Homie Automate](https://github.com/enasisnetwork/enhomie)
- [Enasis Network Chatting Robie](https://github.com/enasisnetwork/enrobie)
- [Enasis Network Orchestrations](https://github.com/enasisnetwork/orchestro)
## Installing the package
Installing stable from the PyPi repository
```
pip install encommon
```
Installing latest from GitHub repository
```
pip install git+https://github.com/enasisnetwork/encommon
```
## Quick start for local development
Start by cloning the repository to your local machine.
```
git clone https://github.com/enasisnetwork/encommon.git
```
Set up the Python virtual environments expected by the Makefile.
```
make -s venv-create
```
### Execute the linters and tests
The comprehensive approach is to use the `check` recipe. This will stop on
any failure that is encountered.
```
make -s check
```
However you can run the linters in a non-blocking mode.
```
make -s linters-pass
```
And finally run the various tests to validate the code and produce coverage
information found in the `htmlcov` folder in the root of the project.
```
make -s pytest
```
## Version management
> :warning: Ensure that no changes are pending.
1. Rebuild the environment.
```
make -s check-revenv
```
1. Update the [version.txt](encommon/version.txt) file.
1. Push to the `main` branch.
1. Create [repository](https://github.com/enasisnetwork/encommon) release.
1. Build the Python package.<br>Be sure no uncommited files in tree.
```
make -s pypackage
```
1. Upload Python package to PyPi test.
```
make -s pypi-upload-test
```
1. Upload Python package to PyPi prod.
```
make -s pypi-upload-prod
```
Raw data
{
"_id": null,
"home_page": null,
"name": "encommon",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": null,
"keywords": null,
"author": null,
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/56/fb/3510988cdb991225b5eefcc557c088ef8b1a8ff1ac7cd14dd76266a6c178/encommon-0.20.5.tar.gz",
"platform": null,
"description": "# Enasis Network Common Library\n\n> :warning: This project has not released its first major version.\n\nCommon classes and functions used in various public and private projects.\n\n<a href=\"https://pypi.org/project/encommon\"><img src=\"https://enasisnetwork.github.io/encommon/badges/pypi.png\"></a><br>\n<a href=\"https://enasisnetwork.github.io/encommon/validate/flake8.txt\"><img src=\"https://enasisnetwork.github.io/encommon/badges/flake8.png\"></a><br>\n<a href=\"https://enasisnetwork.github.io/encommon/validate/pylint.txt\"><img src=\"https://enasisnetwork.github.io/encommon/badges/pylint.png\"></a><br>\n<a href=\"https://enasisnetwork.github.io/encommon/validate/ruff.txt\"><img src=\"https://enasisnetwork.github.io/encommon/badges/ruff.png\"></a><br>\n<a href=\"https://enasisnetwork.github.io/encommon/validate/mypy.txt\"><img src=\"https://enasisnetwork.github.io/encommon/badges/mypy.png\"></a><br>\n<a href=\"https://enasisnetwork.github.io/encommon/validate/yamllint.txt\"><img src=\"https://enasisnetwork.github.io/encommon/badges/yamllint.png\"></a><br>\n<a href=\"https://enasisnetwork.github.io/encommon/validate/pytest.txt\"><img src=\"https://enasisnetwork.github.io/encommon/badges/pytest.png\"></a><br>\n<a href=\"https://enasisnetwork.github.io/encommon/validate/coverage.txt\"><img src=\"https://enasisnetwork.github.io/encommon/badges/coverage.png\"></a><br>\n<a href=\"https://enasisnetwork.github.io/encommon/validate/sphinx.txt\"><img src=\"https://enasisnetwork.github.io/encommon/badges/sphinx.png\"></a><br>\n\n## Documentation\nRead [project documentation](https://enasisnetwork.github.io/encommon/sphinx)\nbuilt using the [Sphinx](https://www.sphinx-doc.org/) project.\nShould you venture into the sections below you will be able to use the\n`sphinx` recipe to build documention in the `sphinx/html` directory.\n\n## Projects using library\n- [Enasis Network Remote Connect](https://github.com/enasisnetwork/enconnect)\n- [Enasis Network Homie Automate](https://github.com/enasisnetwork/enhomie)\n- [Enasis Network Chatting Robie](https://github.com/enasisnetwork/enrobie)\n- [Enasis Network Orchestrations](https://github.com/enasisnetwork/orchestro)\n\n## Installing the package\nInstalling stable from the PyPi repository\n```\npip install encommon\n```\nInstalling latest from GitHub repository\n```\npip install git+https://github.com/enasisnetwork/encommon\n```\n\n## Quick start for local development\nStart by cloning the repository to your local machine.\n```\ngit clone https://github.com/enasisnetwork/encommon.git\n```\nSet up the Python virtual environments expected by the Makefile.\n```\nmake -s venv-create\n```\n\n### Execute the linters and tests\nThe comprehensive approach is to use the `check` recipe. This will stop on\nany failure that is encountered.\n```\nmake -s check\n```\nHowever you can run the linters in a non-blocking mode.\n```\nmake -s linters-pass\n```\nAnd finally run the various tests to validate the code and produce coverage\ninformation found in the `htmlcov` folder in the root of the project.\n```\nmake -s pytest\n```\n\n## Version management\n> :warning: Ensure that no changes are pending.\n\n1. Rebuild the environment.\n ```\n make -s check-revenv\n ```\n\n1. Update the [version.txt](encommon/version.txt) file.\n\n1. Push to the `main` branch.\n\n1. Create [repository](https://github.com/enasisnetwork/encommon) release.\n\n1. Build the Python package.<br>Be sure no uncommited files in tree.\n ```\n make -s pypackage\n ```\n\n1. Upload Python package to PyPi test.\n ```\n make -s pypi-upload-test\n ```\n\n1. Upload Python package to PyPi prod.\n ```\n make -s pypi-upload-prod\n ```\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Enasis Network Common Library",
"version": "0.20.5",
"project_urls": {
"Documentation": "https://enasisnetwork.github.io/encommon/sphinx",
"Source": "https://github.com/enasisnetwork/encommon"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "19afe22722b208a63d669aff82189d9a0eb7a2c4d5186139ed13565c310a0678",
"md5": "45c8a247e4c4cd6d013b34b0009c7a02",
"sha256": "b0ecd5a5784ff3572a6c8b696a6ab5be47fb9b2404d5303c34480f543669e50a"
},
"downloads": -1,
"filename": "encommon-0.20.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "45c8a247e4c4cd6d013b34b0009c7a02",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 90217,
"upload_time": "2024-10-20T11:23:36",
"upload_time_iso_8601": "2024-10-20T11:23:36.189332Z",
"url": "https://files.pythonhosted.org/packages/19/af/e22722b208a63d669aff82189d9a0eb7a2c4d5186139ed13565c310a0678/encommon-0.20.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "56fb3510988cdb991225b5eefcc557c088ef8b1a8ff1ac7cd14dd76266a6c178",
"md5": "91412cddff0f3f42e6526bef30bc9019",
"sha256": "83c297ad940845097f9eb394d15cb7ce8e552f6b74f664410d1745fea320112e"
},
"downloads": -1,
"filename": "encommon-0.20.5.tar.gz",
"has_sig": false,
"md5_digest": "91412cddff0f3f42e6526bef30bc9019",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 54001,
"upload_time": "2024-10-20T11:23:37",
"upload_time_iso_8601": "2024-10-20T11:23:37.857179Z",
"url": "https://files.pythonhosted.org/packages/56/fb/3510988cdb991225b5eefcc557c088ef8b1a8ff1ac7cd14dd76266a6c178/encommon-0.20.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-20 11:23:37",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "enasisnetwork",
"github_project": "encommon",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "encommon"
}
