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
-
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.6.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 36a3a62980b44291e1695fe00847fa66f7afeda9afbc6634679904d8cd760704 |
|
MD5 | b2021931e658e55d298f19eee1de22fb |
|
BLAKE2b-256 | e62908917dec008553163ffe3e677b2074f38026324f295b9baa0930afacfa55 |
Hashes for ambient_package_update-23.5.6-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 868a38e081e1c41813a7b04921609df24f21851ac649a597dae85215df4237d0 |
|
MD5 | 8d6cc741943058912f27c0892fcac80a |
|
BLAKE2b-256 | 8f9aa384657399eed981b7e6a0baf40662acbfff1deeb368fec25df8d8e42d79 |