Ambient package update tool for clean and swift maintenance
Project description
Ambient Package Update
This repository will help keep all Python packages maintained by Ambient Digital tidy and up-to-date.
This package will render all required configuration and installation files for your target package.
Typical use-cases:
- A new Python or Django version was release
- A Python or Django version was deprecated
- You want to update the Sphinx documentation builder
- You want to update the linter versions
- You want to add the third-party dependencies
Versioning
This project follows the CalVer versioning pattern: YY.MM.[RELEASE]
Installation
- Ensure you have installed Python >=3.11 and the binary is in your system path
- Clone this package from GitHub
- Navigate into the project directory
- Execute scripts/setup_venv.ps1 on Windows or scripts/setup_venv_unix.sh on Unix/macOS
Usage
- Navigate to the main directory of this package
- Activate your virtualenv
- Run
python .\main.py render-templates [PACKAGE_NAME]
- Open your target package in the IDE, validate the changes and increment the version accordingly
- Release a new version of your target package
todo:
- docs how to create a new package
- create template dirs if not existing (without .github/workflows it's failing)
- package-readme hat dopplungen zu docs und enthält zeug, das nicht da drinstehen muss
- ambient-toolbox branch löschen und nur rest von core da ablegen
Contribution
Publish to PyPi
-
Update documentation about new/changed functionality
-
Update the
Changelog
-
Increment version in main
__init__.py
-
Increment version of this package in dependencies in
ambient_package_update/metadata/constants.py
-
Create pull request / merge to master
-
This project uses the flit package to publish to PyPI. Thus publishing should be as easy as running:
flit publish
To publish to TestPyPI use the following ensure that you have set up your .pypirc as shown here and use the following command:
flit publish --repository testpypi
Changelog
Can be found at GitHub.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for ambient-package-update-23.5.7.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4843a5500ea75ac5f95141eaf56643e55a25fe23918ec57311c55df8b0fbeb21 |
|
MD5 | d7aebfe6182afe36f07e996eb65390b8 |
|
BLAKE2b-256 | 49d09ae9023f6473a6847913a7d73394d9a3d7f79709f6b2ba882941d4ee358d |
Hashes for ambient_package_update-23.5.7-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4f93543d888acd62be05079b625e7c7b8fc9057d0e6a7d3242d110f96268dea4 |
|
MD5 | d5ea5f128d14c5482ac7cd2732b39f2b |
|
BLAKE2b-256 | 19fab013468e73599f1e9ef3bc1685b14eed6e58d14a28803ce7c92543b593e0 |