To join ecosystem you need to create submission issue and fill in all required details. That's it!

1. Create new environment:

conda create --name ecosystem python=3.13

2. Activate the environment:

conda activate ecosystem

3. Install dependencies:

pip install -r requirements.txt
pip install -r requirements-dev.txt

• Run for style checks tox -elint
• Run for tests tox -epy39
• Run coverage tox -ecoverage
• Run black tox -eblack
• To Fix the black violation black <PATH_FILE_YOU_WANT_TO_FIX>

1. Build the website: tox -ewebsite
2. Go to the website/ folder in the root of your project and open up index.html in a browser

For a faster loop while editing the docs you can run ProperDocs (the drop-in continuation of MkDocs 1.x that builds this site) directly, but first install the package and generate the docs assets:

1. Install the ecosystem package (needed by the gen-files plugin):

pip install -e .

2. Generate the files in docs/assets/:

python manager.py members update_docs_assets

3. Serve the docs with live reload:

properdocs serve

The fragments in docs/assets/ (the tables injected into classifications.md, summary.md, checkups.md, etc. by the table-reader plugin) are generated and not tracked in git. Step 2 is what tox -ewebsite does for you, so if you skip it properdocs serve fails with an error like [table-reader-plugin]: Cannot find table file 'docs/assets/unmaintained.md'. Re-run it whenever you change member data under resources/.

Please follow this link if this is your first time contributing to open source and/or you would like some guidance on how to create and/or merge pull requests.

Internals overview