[Nexus Digital Twin]:https://www.stellaspark.com/
[Pypi account]:https://pypi.org/account/register/
### Description
A collection of python utilities for StellaSpark [Nexus Digital Twin] technology.
### Usage
```
from stellaspark_utils.db import get_indexes, DatabaseManager
from stellaspark_utils.text import parse_time_placeholders
```
### Development
###### Create an environment:
```
cd <project_root>
set PIPENV_VENV_IN_PROJECT=1 && pipenv --python 3.7 # Create a .venv folder in current dir so it's easy to use/maintain by your idea
pipenv shell
pip install -r requirements.txt
pip install -r requirements_dev.txt
```
###### Autoformat code:
```
cd <project_root>
pipenv shell
black . # Make the code look nice
isort . # Sort the import statements
flake8 # Validate the code syntax
```
###### Prepare release
1. Create a [Pypi account] and after registering, make sure your account has a pypi token
2. Update version in setup.py
3. Update the CHANGES.rst with a change message and release date of today
4. Optionally, autoformat code (see above)
5. Push changes to GitHub (preferably in a branch 'release_<x>_<y>')
###### Release manually
```
cd <project_root>
rmdir /s /q "dist" # Remove dist dir (to avoid uploading old distributions)
pipenv shell # Activate pipenv environnment (see 'Create an environment' above)
python setup.py sdist # Create distribution (with a '.tar.gz' in it)
twine check dist/* # Validate all distibutions in stellaspark_utils/dist
twine upload dist/* # Upload distribution to pypi.org
# You will be prompted for a username and password:
# - for the username, use __token__ (yes literally '__token__')
# - for the password, use the pypi token value, including the 'pypi-' prefix
```
Raw data
{
"_id": null,
"home_page": "https://github.com/StellaSpark/stellaspark_utils",
"name": "stellaspark-utils",
"maintainer": "StellaSpark",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "support@stellaspark.com",
"keywords": "stellaspark, nexus, utils, calculation, python",
"author": "StellaSpark",
"author_email": "support@stellaspark.com",
"download_url": "https://files.pythonhosted.org/packages/79/10/7a45e8090506035d8dc834abd2bafdd91c34874c3c59aedf73dfb1701c12/stellaspark-utils-2.1.tar.gz",
"platform": null,
"description": "[Nexus Digital Twin]:https://www.stellaspark.com/ \r\n[Pypi account]:https://pypi.org/account/register/\r\n\r\n\r\n### Description\r\nA collection of python utilities for StellaSpark [Nexus Digital Twin] technology.\r\n\r\n\r\n### Usage\r\n```\r\nfrom stellaspark_utils.db import get_indexes, DatabaseManager\r\nfrom stellaspark_utils.text import parse_time_placeholders\r\n```\r\n\r\n### Development\r\n\r\n###### Create an environment:\r\n```\r\ncd <project_root>\r\nset PIPENV_VENV_IN_PROJECT=1 && pipenv --python 3.7 # Create a .venv folder in current dir so it's easy to use/maintain by your idea\r\npipenv shell\r\npip install -r requirements.txt \r\npip install -r requirements_dev.txt\r\n```\r\n\r\n###### Autoformat code:\r\n```\r\ncd <project_root>\r\npipenv shell\r\nblack . # Make the code look nice\r\nisort . # Sort the import statements\r\nflake8 # Validate the code syntax\r\n```\r\n\r\n###### Prepare release\r\n1. Create a [Pypi account] and after registering, make sure your account has a pypi token\r\n2. Update version in setup.py\r\n3. Update the CHANGES.rst with a change message and release date of today\r\n4. Optionally, autoformat code (see above)\r\n5. Push changes to GitHub (preferably in a branch 'release_<x>_<y>')\r\n\r\n###### Release manually\r\n```\r\ncd <project_root>\r\nrmdir /s /q \"dist\" # Remove dist dir (to avoid uploading old distributions) \r\npipenv shell # Activate pipenv environnment (see 'Create an environment' above)\r\npython setup.py sdist # Create distribution (with a '.tar.gz' in it)\r\ntwine check dist/* # Validate all distibutions in stellaspark_utils/dist\r\ntwine upload dist/* # Upload distribution to pypi.org\r\n# You will be prompted for a username and password: \r\n# - for the username, use __token__ (yes literally '__token__')\r\n# - for the password, use the pypi token value, including the 'pypi-' prefix\r\n```\r\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A collection of python utilities for StellaSpark Nexus Digital Twin",
"version": "2.1",
"project_urls": {
"Download": "https://github.com/StellaSpark/stellaspark_utils/archive/v2.1.tar.gz",
"Homepage": "https://github.com/StellaSpark/stellaspark_utils"
},
"split_keywords": [
"stellaspark",
" nexus",
" utils",
" calculation",
" python"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "79107a45e8090506035d8dc834abd2bafdd91c34874c3c59aedf73dfb1701c12",
"md5": "8117b40d2164c57d1c672d1e3ec161dd",
"sha256": "e69bcd155592b7cc73504b3c8cbacea46471d22564a0c16273e81385535b8e08"
},
"downloads": -1,
"filename": "stellaspark-utils-2.1.tar.gz",
"has_sig": false,
"md5_digest": "8117b40d2164c57d1c672d1e3ec161dd",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 12986,
"upload_time": "2024-10-11T19:54:23",
"upload_time_iso_8601": "2024-10-11T19:54:23.845359Z",
"url": "https://files.pythonhosted.org/packages/79/10/7a45e8090506035d8dc834abd2bafdd91c34874c3c59aedf73dfb1701c12/stellaspark-utils-2.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-11 19:54:23",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "StellaSpark",
"github_project": "stellaspark_utils",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "stellaspark-utils"
}
JSON
