Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Guidelines for adding new Python packages #12

Open
raoulcollenteur opened this issue Sep 25, 2024 · 1 comment
Open

Guidelines for adding new Python packages #12

raoulcollenteur opened this issue Sep 25, 2024 · 1 comment
Assignees
Labels
enhancement New feature or request good first issue Good for newcomers

Comments

@raoulcollenteur
Copy link
Owner

I have restructured how new packages are added. The new format is to add a dictionary with the information about the project to list.json and open a pull request. All the rest will be updated automatically:

    "Pastas": {
        "description": "Analysis of hydrological time series using time series models.",
        "url": "https://github.com/pastas/pastas",
        "category": "Time Series (Analysis)",
        "docs": "https://pastas.readthedocs.io",
        "CI": 1,
        "last_update": "Will be update automatically from conda/pypi",
        "pypi": "https://pypi.org/project/Pastas/",
        "doi_software": "https://doi.org/10.5281/zenodo.1465866",
        "doi_paper": "http://doi.org/10.5281/zenodo.1465866",
        "conda": "https://anaconda.org/conda-forge/Pastas",
        "version": "Will be update automatically from conda/pypi"
    },

I hope this makes everything easier and improves the quality of the list :)

@raoulcollenteur raoulcollenteur pinned this issue Sep 25, 2024
@raoulcollenteur raoulcollenteur self-assigned this Sep 25, 2024
@raoulcollenteur raoulcollenteur added enhancement New feature or request good first issue Good for newcomers labels Sep 25, 2024
@raoulcollenteur
Copy link
Owner Author

raoulcollenteur commented Sep 25, 2024

Good packages should:

  • have documentation (i.e., ReadTheDocs)
  • have continuous integration testing (i.e., GH Actions, Travis)
  • be deposited in a FAIR repository (i.e., Zenodo)
  • be installable with a common Python package manager (i.e., pip, conda, or mamba)
  • have an open-source licenses and code repository

In addition:

  • Nice-to-have is a software description paper.
  • Packages with no releases for the past 5 years are moved to the legacy part.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

1 participant