-
Notifications
You must be signed in to change notification settings - Fork 36
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
3 changed files
with
197 additions
and
0 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,26 @@ | ||
name: Upload Python Package | ||
|
||
on: | ||
release: | ||
types: [created] | ||
|
||
jobs: | ||
deploy: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- uses: actions/checkout@v2 | ||
- name: Set up Python | ||
uses: actions/setup-python@v2 | ||
with: | ||
python-version: "3.x" | ||
- name: Install dependencies | ||
run: | | ||
python -m pip install --upgrade pip | ||
pip install setuptools setuptools-scm wheel twine | ||
- name: Build and publish | ||
env: | ||
TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }} | ||
TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }} | ||
run: | | ||
python setup.py sdist bdist_wheel | ||
twine upload dist/* |
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,26 @@ | ||
# Changelog | ||
|
||
All notable changes to this project will be documented in this file. | ||
|
||
The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) | ||
and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html). | ||
|
||
## [v0.4.1] - 2020-12-03 | ||
|
||
- Bump setup-miniconda from v1 to v2 and remove Travis CI #92 | ||
- Allow netcdf4 engine in opendap driver #91 | ||
- Add logic for remote or local files in NetCDFSource #93 | ||
|
||
## [v0.4.0] - 2020-10-14 | ||
|
||
- Logic for remote versus local filepaths for RasterIOSource + GitHub Actions CI #82 | ||
- add github action for pytest on linux #83 | ||
|
||
*changelog started with v0.4.0...* | ||
|
||
## Compare adjacent versions: | ||
|
||
[v0.4.1]: https://github.com/intake/intake-xarray/compare/0.4.1...0.4.0 | ||
[v0.4.0]: https://github.com/intake/intake-xarray/compare/0.4.0...0.3.2 | ||
[v0.3.2]: https://github.com/intake/intake-xarray/compare/0.3.2...0.3.1 | ||
[v0.3.1]: https://github.com/intake/intake-xarray/compare/0.3.1...0.3.0 |
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,145 @@ | ||
============================ | ||
Contributing to intake-xarray | ||
============================ | ||
|
||
Contributions are highly welcomed and appreciated. Every little help counts, | ||
so do not hesitate! | ||
|
||
.. contents:: Contribution links | ||
:depth: 2 | ||
|
||
|
||
.. _submitfeedback: | ||
|
||
Feature requests and feedback | ||
----------------------------- | ||
|
||
Do you like intake-xarray? Share some love on Twitter or in your blog posts! | ||
|
||
We'd also like to hear about your propositions and suggestions. Feel free to | ||
`submit them as issues <https://github.com/intake/intake-xarray>`_ and: | ||
|
||
* Explain in detail how they should work. | ||
* Keep the scope as narrow as possible. This will make it easier to implement. | ||
|
||
|
||
.. _reportbugs: | ||
|
||
Report bugs | ||
----------- | ||
|
||
Report bugs for intake-stac in the `issue tracker <https://github.com/intake/intake-xarray>`_. | ||
|
||
If you are reporting a bug, please include: | ||
|
||
* Your operating system name and version. | ||
* Any details about your local setup that might be helpful in troubleshooting, | ||
specifically the Python interpreter version, installed libraries, and intake-stac | ||
version. | ||
* Detailed steps to reproduce the bug. | ||
|
||
If you can write a demonstration test that currently fails but should pass | ||
(xfail), that is a very useful commit to make as well, even if you cannot | ||
fix the bug itself. | ||
|
||
|
||
.. _fixbugs: | ||
|
||
Fix bugs | ||
-------- | ||
|
||
Look through the `GitHub issues for bugs <https://github.com/intake/intake-xarray/labels/type:%20bug>`_. | ||
|
||
Talk to developers to find out how you can fix specific bugs. | ||
|
||
|
||
Write documentation | ||
------------------- | ||
|
||
intake-xarray could always use more documentation. What exactly is needed? | ||
|
||
* More complementary documentation. Have you perhaps found something unclear? | ||
* Docstrings. There can never be too many of them. | ||
* Blog posts, articles and such -- they're all very appreciated. | ||
|
||
You can also edit documentation files directly in the GitHub web interface, | ||
without using a local copy. This can be convenient for small fixes. | ||
|
||
.. note:: | ||
Build the documentation locally with the following command: | ||
|
||
.. code:: bash | ||
$ conda env create -f docs/environment.yml | ||
$ cd docs | ||
$ make html | ||
The built documentation should be available in the ``docs/_build/``. | ||
|
||
|
||
|
||
.. _`pull requests`: | ||
.. _pull-requests: | ||
|
||
|
||
Preparing Pull Requests | ||
----------------------- | ||
|
||
|
||
#. Fork the | ||
`intake-xarray GitHub repository <https://github.com/intake/intake-xarray>`__. It's | ||
fine to use ``intake-xarray`` as your fork repository name because it will live | ||
under your user. | ||
|
||
|
||
#. Clone your fork locally using `git <https://git-scm.com/>`_ and create a branch:: | ||
|
||
$ git clone git@github.com:YOUR_GITHUB_USERNAME/intake-xarray.git | ||
$ cd intake-xarray | ||
|
||
# now, to fix a bug or add feature create your own branch off "master": | ||
|
||
$ git checkout -b your-bugfix-feature-branch-name master | ||
|
||
|
||
#. Install development version in a conda environment:: | ||
|
||
$ conda env create -f ci/environment-py39.yml | ||
$ conda activate test_env | ||
$ pip install . -e | ||
|
||
|
||
#. Run all the tests | ||
|
||
Now running tests is as simple as issuing this command:: | ||
|
||
$ pytest --verbose | ||
|
||
|
||
This command will run tests via the "pytest" tool | ||
|
||
|
||
#. Commit and push once your tests pass and you are happy with your change(s):: | ||
|
||
$ git commit -a -m "<commit message>" | ||
$ git push -u | ||
|
||
|
||
#. Finally, submit a pull request through the GitHub website using this data:: | ||
|
||
head-fork: YOUR_GITHUB_USERNAME/intake-xarray | ||
compare: your-branch-name | ||
|
||
base-fork: intake/intake-xarray | ||
base: master | ||
|
||
|
||
.. _`release a new version`: | ||
.. _release-a-new-version: | ||
|
||
|
||
Release a new version | ||
--------------------- | ||
|
||
intake-xarray uses the pypipublish GitHub action to publish new versions on PYPI. Just create a new tag `git tag 0.4.1`, `git push upstream --tags`, then create a release by visiting https://github.com/intake/intake-xarray/releases/new. When the release is created the version will automatically be uploaded to https://pypi.org/project/intake-xarray/. | ||
|