-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #287 from MeteoSwiss/develop
v1.0.0
- Loading branch information
Showing
105 changed files
with
4,548 additions
and
2,298 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,57 @@ | ||
| # This workflow will push the code onto pypi. | ||
| # It assumes that TESTPYPI_API_TOKEN and PYPI_API_TOKEN secrets from GITHUB have been defined | ||
| # at the repo or organization levels to upload the package via API authentification. | ||
| # | ||
| # It will trigger the moment a new release or pre-release is being published. | ||
| # | ||
| # Copyright (c) 2023 fpavogt; [email protected] | ||
|
|
||
| name: CI_pypi | ||
|
|
||
| on: | ||
| release: | ||
| types: [published] | ||
|
|
||
| jobs: | ||
| pypi: | ||
|
|
||
| runs-on: ubuntu-latest | ||
| steps: | ||
|
|
||
| - name: Checkout current repository | ||
| uses: actions/checkout@v2 | ||
|
|
||
| - name: Set up Python | ||
| uses: actions/setup-python@v2 | ||
| with: | ||
| python-version: '3.10' | ||
|
|
||
| - name: Install dependancies | ||
| run: | | ||
| python -m pip install --upgrade pip | ||
| pip install setuptools | ||
| pip install wheel | ||
| pip install twine | ||
| shell: bash | ||
|
|
||
| - name: Build the wheels | ||
| run: | | ||
| python setup.py sdist bdist_wheel | ||
| shell: bash | ||
|
|
||
| - name: Deploy to testpypi | ||
| # Let's make use of Github secrets to avoid spelling out secret stuff | ||
| env: | ||
| TESTPYPI_TOKEN: ${{ secrets.TESTPYPI_API_TOKEN }} | ||
| # We first go to testpypi to make sure nothing blows up. | ||
| run: | | ||
| twine upload -r testpypi dist/* --verbose --skip-existing -u __token__ -p "$TESTPYPI_TOKEN" | ||
| shell: bash | ||
|
|
||
| - name: Deploy to pypi | ||
| # Let's make use of Github secrets to avoid spelling out secret stuff | ||
| env: | ||
| PYPI_TOKEN: ${{ secrets.PYPI_API_TOKEN }} | ||
| run: | | ||
| twine upload dist/* --verbose --skip-existing -u __token__ -p "$PYPI_TOKEN" | ||
| shell: bash |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,20 +1,16 @@ | ||
| # Contributing to dvas | ||
|
|
||
| |:warning: it is not forseen that dvas will be developed or actively maintained beyond 2023-11-30. | | ||
| | --- | | ||
|
|
||
| If you have a question about dvas, [jump here](#asking-a-question). | ||
| If you want to report a bug with dvas, [jump here](#reporting-a-bug). | ||
|
|
||
| If you are still reading this, you may actually be considering contributing to the development of dvas. :heart_eyes: :tada: | ||
|
|
||
| There are many ways that you can do so, including by: | ||
| - [reporting a bug](#reporting-a-bug) | ||
| - fixing an [known issue](https://github.com/MeteoSwiss-MDA/dvas/issues?q=is%3Aissue+), | ||
| - implementing a new functionality, and/or | ||
| - improving the documentation: | ||
| * in the code, with better docstrings | ||
| * in this repository (for example this very file !) | ||
| * in the website, via the docs `.rst` files | ||
| If you are still reading this, you may actually be considering contributing to the development of dvas. At this stage, the development of dvas is not forseen beyond 2021-11-30. The project will | ||
| likely be frozen on that date, and kept as-is for legacy purposes. | ||
|
|
||
| All these contributions are welcome, and what follows should help you get started. Note that contributing to dvas does *not* necessarily require an advanced knowledge of Python and/or Github. Helping us fix typos in the docs, for example, could be an excellent first contribution. Plus, :anger: typos :anger: are the worst ! | ||
| Below, we provide some basic elements of the project for the benefit of anyone interested to know | ||
| more about it. | ||
|
|
||
| ## Table of contents | ||
|
|
||
|
|
@@ -37,7 +33,7 @@ The [dvas Github Discussions page](https://github.com/MeteoSwiss-MDA/dvas/discus | |
| If you find something odd/wrong/broken with dvas, first check if it is a [known issue](https://github.com/MeteoSwiss-MDA/dvas/issues?q=is%3Aissue+). If not, please create a new [Github Issue](https://github.com/MeteoSwiss-MDA/dvas/issues). This is the best way for everyone to keep track of new problems and past solutions. | ||
|
|
||
| ## Essential things to know about dvas | ||
| dvas is a Python package composed of two sub-packages: `dvas` lies at its core, with `dvas_recipes` wrapped around it. In practice, dvas also includes a series of parameter and | ||
| dvas is a Python package composed of two sub-packages: `dvas` lies at its core, with `dvas_recipes` wrapped around it. In practice, dvas also includes a series of parameters and | ||
| utilitarian files related to its Github repository, and a dedicated documentation hosted using Github pages. | ||
|
|
||
| For the sake of clarity, and to facilitate the code maintenance, we list here (succinctly) a series of key facts about the dvas code and its repository: | ||
|
|
@@ -70,7 +66,7 @@ For the sake of clarity, and to facilitate the code maintenance, we list here (s | |
| [plantuml server](http://www.plantuml.com/plantuml). | ||
|
|
||
| 4. **Development utilities:** | ||
| * On Windows, linter and tests can be run locally from terminal with `sh .\.dev_utils\linter_bash.bat` | ||
| * On Windows, linter and tests can be run locally from a terminal with `sh .\.dev_utils\linter_bash.bat` | ||
| resp. `sh .\.dev_utils\test_bash.bat` commands. | ||
| * There is a script to update the copyright years in all the `.py` files in the repository, that | ||
| can be run as follows: | ||
|
|
@@ -171,9 +167,7 @@ For the sake of clarity, and to facilitate the code maintenance, we list here (s | |
| ## Step-by-step guide to contributing | ||
| We are currently in the early stages of development of dvas. If you would like to contribute to the code, please contact [[email protected]](mailto:[email protected]). | ||
| Until its release, the dvas repository will remain private: branching will thus remain the only way to contribute to the code. To get a local copy of dvas and contribute to its improvement, one can follow the following steps: | ||
| Until its release, the dvas repository remained private: branching was the only way to contribute to the code. To get a local copy of dvas and contribute to its improvement, one could then follow the following steps: | ||
| 0. Make sure you have git installed. Check that the setup is correct: | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.