Skip to content

Commit

Permalink
chore: switch from antarctic-plots to polartoolkit
Browse files Browse the repository at this point in the history
  • Loading branch information
mdtanker committed Jan 26, 2024
1 parent 62c0385 commit bac23a9
Show file tree
Hide file tree
Showing 53 changed files with 553 additions and 376 deletions.
34 changes: 17 additions & 17 deletions .github/CONTRIBUTING.md
Expand Up @@ -3,7 +3,7 @@

<sub>Adapted from the great contribution guidelines of the [Fatiando a Terra](https://www.fatiando.org/) packages<sub>.

> This document contains some general guidlines to help with contributing to this code. Contributing to a package can be a daunting task, if you want help please reach out on the [GitHub discussions page](https://github.com/mdtanker/antarctic_plots/discussions)!
> This document contains some general guidlines to help with contributing to this code. Contributing to a package can be a daunting task, if you want help please reach out on the [GitHub discussions page](https://github.com/mdtanker/polartoolkit/discussions)!
Any kind of help would be much appreciated. Here are a few ways to contribute:
* 🐛 Submitting bug reports and feature requests
Expand Down Expand Up @@ -90,7 +90,7 @@ example scripts. See [Contributing Code](#contributing-code) for instructions.

**Is this your first contribution?**
Please take a look at these resources to learn about git and pull requests (don't
hesitate to ask questions in the [GitHub discussions page](https://github.com/mdtanker/antarctic_plots/discussions)):
hesitate to ask questions in the [GitHub discussions page](https://github.com/mdtanker/polartoolkit/discussions)):

* [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/).
* Aaron Meurer's [tutorial on the git workflow](http://www.asmeurer.com/git-workflow/)
Expand All @@ -111,28 +111,28 @@ versiones con Git](https://swcarpentry.github.io/git-novice-es/)
To get the latest version clone the github repo:

```
git clone https://github.com/mdtanker/antarctic_plots.git
git clone https://github.com/mdtanker/polartoolkit.git
```
Change into the directory:

```
cd antarctic_plots
cd polartoolkit
```

Run the following command to make a new environment and install the package dependencies:

```
make create
```
Activate the environement:
Activate the environment:
```
conda activate antarctic_plots
conda activate polartoolkit
```
Install your local version:
```
make install
```
This environment now contains your local, editable version of Antarctic-Plots, meaning if you alter code in the package, it will automatically include those changes in your environement (you may need to restart your kernel if using Jupyter). If you need to update the dependencies, see the [update the dependencies](#update-the-dependencies) section below.
This environment now contains your local, editable version of PolarToolkit, meaning if you alter code in the package, it will automatically include those changes in your environment (you may need to restart your kernel if using Jupyter). If you need to update the dependencies, see the [update the dependencies](#update-the-dependencies) section below.

> **Note:** You'll need to activate the environment every time you start a new terminal.
Expand Down Expand Up @@ -257,7 +257,7 @@ This includes running both the unit tests as well as code linters.
GitHub will show the status of these checks on the pull request.
Try to get them all passing (green).
If you have any trouble, leave a comment in the PR or
[post on the GH discussions page](https://github.com/mdtanker/antarctic_plots/discussions).
[post on the GH discussions page](https://github.com/mdtanker/polartoolkit/discussions).

## Publish a new release

Expand All @@ -266,7 +266,7 @@ This will almost always be done by the developers, but as a guide for them, here
Follow all the above instructions for formating and building the docs

### PyPI (pip)
Manually increment the version in antarctic_plots/__init__.py:
Manually increment the version in polartoolkit/__init__.py:

version = "X.Y.Z"

Expand All @@ -283,11 +283,11 @@ This should automatically find the TestPyPI username and token from a `.pypirc`
Make a new environment and activate it:

make test_pypi_env
mamba activate antarctic_plots_test_pypi
mamba activate polartoolkit_test_pypi

and run the following, replacing the asterisks with the version number:

pip install --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple/ antarctic-plots==******
pip install --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple/ polartoolkit==******

Run a few gallery examples to make sure this env works, then its ready to publish to the real PyPI:

Expand All @@ -298,25 +298,25 @@ Now push the changes to GitHub and make a release with the matching version numb
### Conda-Forge
Once the new version is on PyPI, we can update the conda-forge feedstock.

Fork the [conda-forge antarctic-plots feedstock](https://github.com/conda-forge/antarctic-plots-feedstock) on github:
Fork the [conda-forge polartoolkit feedstock](https://github.com/conda-forge/polartoolkit-feedstock) on github:

Clone the fork and checkout a new branch

git clone https://github.com/mdtanker/antarctic-plots-feedstock
git clone https://github.com/mdtanker/polartoolkit-feedstock

git checkout -b update

Update the `meta.yaml` with the new PyPI version with `grayskull`

grayskull pypi antarctic-plots
grayskull pypi polartoolkit

Copy the new contents into the old `meta.yaml` file.

Push the changes to GitHub

git add .

git commit -m "updating antarctic-plots"
git commit -m "updating polartoolkit"

git push origin update

Expand All @@ -338,8 +338,8 @@ To run this package online, Read the Docs will automatically create a Binder ins

make conda_install

conda activate antarctic_plots
conda activate polartoolkit

make binder_env

Now, when submitting a PR, RTD will automatically build the docs and update the Binder environement.
Now, when submitting a PR, RTD will automatically build the docs and update the Binder environment.
12 changes: 6 additions & 6 deletions .github/config.yml
Expand Up @@ -5,16 +5,16 @@

# Comment to be posted to on first time issues
newIssueWelcomeComment: >
👋 Thanks for opening your first issue here! Please make sure you filled out the template with as much detail as possible. You might also want to take a look at our [contributing guidelines](https://github.com/mdtanker/antarctic_plots/blob/main/docs/contribute.md).
👋 Thanks for opening your first issue here! Please make sure you filled out the template with as much detail as possible. You might also want to take a look at our [contributing guidelines](https://github.com/mdtanker/polartoolkit/blob/main/docs/contribute.md).
# Configuration for new-pr-welcome - https://github.com/behaviorbot/new-pr-welcome

# Comment to be posted to on PRs from first time contributors in your repository
newPRWelcomeComment: >
💖 Thanks for opening this pull request! 💖
Please make sure you read our [contributing guidelines](https://github.com/mdtanker/antarctic_plots/blob/main/docs/contribute.md).
💖 Thanks for opening this pull request! 💖
Please make sure you read our [contributing guidelines](https://github.com/mdtanker/polartoolkit/blob/main/docs/contribute.md).
A few things to keep in mind:
* If you need help writing tests, take a look at the existing ones for inspiration. If you don't know where to start, let us know and we'll walk you through it.
Expand All @@ -26,5 +26,5 @@ newPRWelcomeComment: >
# Comment to be posted to on pull requests merged by a first time user
firstPRMergeComment: >
🎉🎉🎉 Congrats on merging your first pull request and welcome to the team! 🎉🎉🎉
We hope that this was a good experience for you. Let us know if there is any way that the contributing process could be improved.
2 changes: 1 addition & 1 deletion .github/workflows/ci.yml
Expand Up @@ -72,7 +72,7 @@ jobs:
- name: Setup Mambaforge
uses: conda-incubator/setup-miniconda@v3
with:
activate-environment: antarctic_plots
activate-environment: polartoolkit
environment-file: env/test_env.yml
python-version: ${{ matrix.python-version }}
channels: conda-forge,nodefaults
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/push.yml
Expand Up @@ -18,7 +18,7 @@ jobs:
contents: write
environment:
name: testpypi
url: https://pypi.org/p/antarctic-plots
url: https://pypi.org/p/polartoolkit
steps:
# checkout the repo and supply a PAT for the changelog update commit.
- id: checkout
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/release.yml
Expand Up @@ -31,7 +31,7 @@ jobs:
id-token: write # IMPORTANT: this permission is mandatory for trusted publishing
environment:
name: testpypi
url: https://pypi.org/p/antarctic-plots
url: https://pypi.org/p/polartoolkit
needs: [build-package]
steps:
# Download the build package files
Expand All @@ -54,7 +54,7 @@ jobs:
id-token: write # IMPORTANT: this permission is mandatory for trusted publishing
environment:
name: pypi
url: https://pypi.org/p/antarctic-plots
url: https://pypi.org/p/polartoolkit
needs: [build-package]
steps:
# Download the build package files
Expand Down
12 changes: 6 additions & 6 deletions .pre-commit-config.yaml
Expand Up @@ -5,12 +5,12 @@ ci:
exclude: |
(?x)^(
docs/index.md|
docs/api/antarctic_plots.rst|
docs/api/antarctic_plots.fetch.rst|
docs/api/antarctic_plots.maps.rst|
docs/api/antarctic_plots.profile.rst|
docs/api/antarctic_plots.regions.rst|
docs/api/antarctic_plots.utils.rst|
docs/api/polartoolkit.rst|
docs/api/polartoolkit.fetch.rst|
docs/api/polartoolkit.maps.rst|
docs/api/polartoolkit.profile.rst|
docs/api/polartoolkit.regions.rst|
docs/api/polartoolkit.utils.rst|
CHANGELOG.md|
.github/ISSUE_TEMPLATE/bug_report.md|
.github/ISSUE_TEMPLATE/feature_request.md|
Expand Down

0 comments on commit bac23a9

Please sign in to comment.