Developer Guide

Insall pip

python3 -m pip install

Clone the repository

git clone git@github.com:Issamricin/dmc-view.git
cd dmc-view

Make the project in edit mode

pip install -e .

Publish Notes

Steps to test the publish on pypi see workflow files for publish on pypi test server (release_test.yaml)

If you do update for the README.rst , please copy and paste into RST-Check

git clone git@github.com:Issamricin/dmc-view.git
python -m venv .venv

You need to install tox on to run the workflow tox task or env run task

tox check list before you push to remote repo

python -m pip install tox
tox -v -s false -e pin-deps
tox -e type -v -s false
tox -v -s false | tee test_output.log
tox -e coverage --sitepackages -v -s false
tox -e wheel-test -s false
tox -e check -v -s false
tox -e isort -vv -s false
tox -e black -vv -s false
tox -e ruff -vv -s false
tox -e prospector -vv -s false

Below is to build and check the twine for pypi publish in case an error in the markup you need to check rst online

Making Friendly PyPi Package

python -m pip install build
python -m build -s
python -m build --wheel
python -m pip install --upgrade twine
twine check dist/*

Now you need to have your test project setup on testpypi Publishing so to trigger the workflow you need to create a test tag and push it so it triggers the release_test.yaml Before you do that update your package version in the toml, tox and __init__.py file

suppose my package release is 0.3.3
Test tag  is test-0.3.3
Prod tag is release-0.3.3

To trigger the release into test pypi
$  git tag test-0.3.3
$  git push origin  –tags

Git Basic Tag Commands

Developer Notes

Testing, Documentation Building, Scripts, CI/CD, Static Code Analysis for this project.

Test Suite, using `pytest`_, located in tests dir
Parallel Execution of Unit Tests, on multiple cpu’s
Documentation Pages, hosted on readthedocs server, located in docs dir
CI(Continuous Integration)/CD(Continuous Delivery) Pipeline, running on Github Actions, defined in .github/
1. Test Job Matrix, spanning different platform’s and python version’s
  1. Platforms: ubuntu-latest
  2. Python Interpreters: 3.13
2. Continuous Deployment
  
  Production
  1. Python Distristribution to `pypi.org`_, on tags v*, pushed to main branch
  2. Docker Image to `Dockerhub`_, on every push, with automatic Image Tagging
  Staging
  1. Python Distristribution to `test.pypi.org`_, on “pre-release” tags v*-rc, pushed to release branch
3. Configurable Policies for Docker, and Static Code Analysis Workflows
Automation, using `tox`_, driven by single tox.ini file
1. Code Coverage measuring
2. Build Command, using the `build`_ python package
3. Pypi Deploy Command, supporting upload to both `pypi.org`_ and `test.pypi.org`_ servers
4. Type Check Command, using `mypy`_
5. Lint Check and Apply commands, using the fast `Ruff`_ linter, along with `isort`_ and `black`_