ambient-package-update 23.5.6

Ambient package update tool for clean and swift maintenance

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

1. Ensure you have installed Python >=3.11 and the binary is in your system path
2. Clone this package from GitHub
3. Navigate into the project directory
4. 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.