Skip to content

Commit

Permalink
Update packaging settings
Browse files Browse the repository at this point in the history
  • Loading branch information
ghiggi committed Apr 3, 2024
1 parent 54f1a21 commit 3c0f0aa
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 10 deletions.
18 changes: 9 additions & 9 deletions docs/source/07_maintainers_guidelines.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,14 @@ Maintainers Guidelines
The section is dedicated to the GPM-API core developers (maintainers).


Core contributors
Core Contributors
====================

* Current Release Manager : Ghiggi Gionata
* Testing Team : Ghiggi Gionata, Son Pham-Ba


Versions guidelines
Versions Guidelines
========================

GPM-API uses `Semantic <https://semver.org/>`_ Versioning. Each release is associated with a git tag of the form X.Y.Z.
Expand Down Expand Up @@ -67,7 +67,7 @@ styled with `Book Theme <https://sphinx-book-theme.readthedocs.io/en/stable/inde
All documentation source files are neatly organized in the ``docs/`` directory within the project's repository.


Documentation generation
Documentation Generation
--------------------------

To build the documentation locally, follow the next three steps.
Expand Down Expand Up @@ -111,7 +111,7 @@ To build the documentation locally, follow the next three steps.
By following these steps, you should have a local version of the GPM-API documentation
in the ``docs/build/html/`` directory, ready for review or deployment!

Documentation deployment
Documentation Deployment
--------------------------

A webhook is defined in the GitHub repository to trigger automatically the publication process to `ReadTheDocs <https://about.readthedocs.com/?ref=readthedocs.com>`__
Expand All @@ -124,7 +124,7 @@ This webhook is linked to the GPM-API core developer.
Ghiggi Gionata owns the `ReadTheDocs <https://readthedocs.org/>`__ account.


Package release
Package Release
============================

A `GitHub Action <https://github.com/ghiggi/gpm_api/actions>`_ is configured to automate the packaging and uploading process to `PyPI <https://pypi.org/project/gpm-api/>`_.
Expand All @@ -138,7 +138,7 @@ Once the conda-forge recipe is updated, a new conda-forge package is released.
The PyPI project and the conda-forge recipes are collaboratively maintained by core contributors of the project.


Release process
Release Process
----------------

Before releasing a new version, the ``CHANGELOG.md`` file should be updated.
Expand Down Expand Up @@ -181,14 +181,14 @@ The review process is the following:



Continuous Integration (CI)
Continuous Integration
==============================

Continuous integration (CI) is a crucial practice in modern software development, ensuring that code changes are regularly integrated into the main codebase.
Continuous Integration (CI) is a crucial practice in modern software development, ensuring that code changes are regularly integrated into the main codebase.
With CI, each commit or pull request triggers an automated process that verifies the integrity of the codebase, runs tests,
and performs various checks to catch issues early in the development lifecycle.

The table below summarizes the software tools utilized in our CI pipeline, descibes their respective aims and project pages.
The table below summarizes the software tools utilized in our CI pipeline, describes their respective aims and project pages.

+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------+----------------------------------------------------------------------------------------------+
| Tools | Aim | Project page |
Expand Down
5 changes: 4 additions & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,10 @@ changelog = "https://github.com/ghiggi/gpm_api/blob/main/CHANGELOG.md"
write_to = "gpm/_version.py"

[tool.setuptools]
packages = ["gpm"] # explicitly list the packages in modules
license-files = ["LICENSE"]

[tool.setuptools.packages.find]
include = ["gpm*"]

[project.scripts]
download_gpm_daily_data="gpm.scripts.download_gpm_daily_data:download_gpm_daily_data"
Expand Down

0 comments on commit 3c0f0aa

Please sign in to comment.