Skip to content

Commit a23f44a

Browse files
authored
Rename the package to PyGMT (#265)
GMT/Python is a bad name because it can't be translated into a repository or Python package name easily. What we have now is a repository called `gmt-python`, a website `gmtpython`, a package `gmt`, and a PyPI package `gmt-python`. This is madness. Since all other GMT Python wrappers are dead, we'll rebrand as PyGMT (repo and packages will be `pygmt`). This renames the package and imports so that the tests pass and the docs build. I'm sure we'll find many references to `gmt` but we can fix those with time. Fixes #263
1 parent 7675312 commit a23f44a

File tree

95 files changed

+125
-120
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

95 files changed

+125
-120
lines changed

.codeclimate.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ plugins:
1919
enabled: true
2020
config:
2121
test_patterns:
22-
- "gmt/**/tests/*.py"
22+
- "pygmt/**/tests/*.py"
2323
checks:
2424
python:S3776:
2525
enabled: false
@@ -30,7 +30,7 @@ plugins:
3030

3131
exclude_paths:
3232
- "versioneer.py"
33-
- "gmt/_version.py"
33+
- "pygmt/_version.py"
3434
- "doc/**/*"
35-
- "gmt/tests/baseline/*"
36-
- "gmt/tests/data/*"
35+
- "pygmt/tests/baseline/*"
36+
- "pygmt/tests/data/*"

.coveragerc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,4 @@
22
omit =
33
*/tests/*
44
*/_version.py
5-
*gmt/__init__.py
5+
*pygmt/__init__.py

.gitattributes

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
gmt/_version.py export-subst
1+
pygmt/_version.py export-subst

.github/config.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,13 @@
22
########################################################################################
33
# Comment to be posted to on first time issues
44
newIssueWelcomeComment: |
5-
👋 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/GenericMappingTools/gmt-python/blob/master/CONTRIBUTING.md) and [code of conduct](https://github.com/GenericMappingTools/gmt-python/blob/master/CODE_OF_CONDUCT.md).
5+
👋 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/GenericMappingTools/pygmt/blob/master/CONTRIBUTING.md) and [code of conduct](https://github.com/GenericMappingTools/pygmt/blob/master/CODE_OF_CONDUCT.md).
66
77
# Comment to be posted to on PRs from first time contributors in your repository
88
newPRWelcomeComment: |
99
💖 Thanks for opening this pull request! 💖
1010
11-
Please make sure you read our [contributing guidelines](https://github.com/GenericMappingTools/gmt-python/blob/master/CONTRIBUTING.md) and abide by our [code of conduct](https://github.com/GenericMappingTools/gmt-python/blob/master/CODE_OF_CONDUCT.md).
11+
Please make sure you read our [contributing guidelines](https://github.com/GenericMappingTools/pygmt/blob/master/CONTRIBUTING.md) and abide by our [code of conduct](https://github.com/GenericMappingTools/pygmt/blob/master/CODE_OF_CONDUCT.md).
1212
1313
A few things to keep in mind:
1414

.stickler.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,4 +9,4 @@ linters:
99
csslint:
1010
enable: false
1111
files:
12-
ignore: ['versioneer.py', 'gmt/_version.py', 'doc/conf.py']
12+
ignore: ['versioneer.py', 'pygmt/_version.py', 'doc/conf.py']

CONTRIBUTING.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -246,9 +246,9 @@ Leave a comment in the PR and we'll help you out.
246246
We use the [pytest-mpl](https://github.com/matplotlib/pytest-mpl) plug-in to test plot
247247
generating code.
248248
Every time the tests are run, `pytest-mpl` compares the generated plots with known
249-
correct ones stored in `gmt/tests/baseline`.
250-
If your test created a `gmt.Figure` object, you can test it by adding a *decorator* and
251-
returning the `gmt.Figure` object:
249+
correct ones stored in `pygmt/tests/baseline`.
250+
If your test created a `pygmt.Figure` object, you can test it by adding a *decorator* and
251+
returning the `pygmt.Figure` object:
252252

253253
```python
254254
@pytest.mark.mpl_image_compare
@@ -260,21 +260,21 @@ def test_my_plotting_case():
260260
return fig
261261
```
262262

263-
Your test function **must** return the `gmt.Figure` object and you can only
263+
Your test function **must** return the `pygmt.Figure` object and you can only
264264
test one figure per function.
265265

266266
Before you can run your test, you'll need to generate a *baseline* (a correct
267267
version) of your plot.
268268
Run the following from the repository root:
269269

270270
```bash
271-
py.test --mpl-generate-path=baseline gmt/tests/NAME_OF_TEST_FILE.py
271+
py.test --mpl-generate-path=baseline pygmt/tests/NAME_OF_TEST_FILE.py
272272
```
273273

274274
This will create a `baseline` folder with all the plots generated in your test
275275
file.
276276
Visually inspect the one corresponding to your test function.
277-
If it's correct, copy it (and only it) to `gmt/tests/baseline`.
277+
If it's correct, copy it (and only it) to `pygmt/tests/baseline`.
278278
When you run `make test` the next time, your test should be executed and
279279
passing.
280280

MAINTENANCE.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ There are a few steps that still must be done manually, though.
8181
2. Edit the changes list to remove any trivial changes (updates to the README, typo
8282
fixes, CI configuration, etc).
8383
3. Replace the PR number in the commit titles with a link to the Github PR page. In Vim,
84-
use `` %s$#\([0-9]\+\)$`#\1 <https://github.com/GenericMappingTools/gmt-python/pull/\1>`__$g ``
84+
use `` %s$#\([0-9]\+\)$`#\1 <https://github.com/GenericMappingTools/pygmt/pull/\1>`__$g ``
8585
to make the change automatically.
8686
4. Copy the remaining changes to `doc/changes.rst` under a new section for the
8787
intended release.
@@ -132,7 +132,7 @@ After Travis is done building the tag and all builds pass, we need to update the
132132
package.
133133
Unfortunately, this needs to be done manually for now.
134134

135-
1. Fork the feedstock repository (https://github.com/conda-forge/gmt-python-feedstock) if
135+
1. Fork the feedstock repository (https://github.com/conda-forge/pygmt-feedstock) if
136136
you haven't already. If you have a fork, update it.
137137
2. Update the version number and sha256 hash on `recipe/meta.yaml`. You can get the hash
138138
from the PyPI "Download files" section.

MANIFEST.in

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,6 @@ include CODE_OF_CONDUCT.md
44
include CONTRIBUTING.md
55
include AUTHORS.md
66
include versioneer.py
7-
include gmt/_version.py
8-
recursive-include gmt/tests/data *
9-
recursive-include gmt/tests/baseline *
7+
include pygmt/_version.py
8+
recursive-include pygmt/tests/data *
9+
recursive-include pygmt/tests/baseline *

Makefile

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# Build, package, test, and clean
2-
PROJECT=gmt
2+
PROJECT=pygmt
33
TESTDIR=tmp-test-dir-with-unique-name
44
PYTEST_ARGS=--cov-config=../.coveragerc --cov-report=term-missing --cov=$(PROJECT) --doctest-modules -v --pyargs
55
BLACK_FILES=$(PROJECT) setup.py doc/conf.py
@@ -24,7 +24,7 @@ test:
2424
# Run a tmp folder to make sure the tests are run on the installed version
2525
mkdir -p $(TESTDIR)
2626
@echo ""
27-
@cd $(TESTDIR); python -c "import gmt; gmt.print_clib_info()"
27+
@cd $(TESTDIR); python -c "import $(PROJECT); $(PROJECT).print_clib_info()"
2828
@echo ""
2929
cd $(TESTDIR); pytest $(PYTEST_ARGS) $(PROJECT)
3030
cp $(TESTDIR)/.coverage* .

README.rst

Lines changed: 26 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,29 @@
1-
GMT/Python
2-
==========
1+
PyGMT
2+
=====
33

44
A Python interface for the Generic Mapping Tools
55

66
`Documentation (development version) <https://www.gmtpython.xyz>`__ |
7-
`Contact <https://gitter.im/GenericMappingTools/gmt-python>`__
7+
`Contact <https://gitter.im/GenericMappingTools/pygmt>`__
88

9-
.. image:: http://img.shields.io/pypi/v/gmt-python.svg?style=flat-square
9+
.. image:: http://img.shields.io/pypi/v/pygmt.svg?style=flat-square
1010
:alt: Latest version on PyPI
11-
:target: https://pypi.python.org/pypi/gmt-python
12-
.. image:: http://img.shields.io/travis/GenericMappingTools/gmt-python/master.svg?style=flat-square&label=Linux|Mac
11+
:target: https://pypi.python.org/pypi/pygmt
12+
.. image:: http://img.shields.io/travis/GenericMappingTools/pygmt/master.svg?style=flat-square&label=Linux|Mac
1313
:alt: Travis CI build status
14-
:target: https://travis-ci.org/GenericMappingTools/gmt-python
15-
.. image:: https://img.shields.io/codecov/c/github/GenericMappingTools/gmt-python/master.svg?style=flat-square
14+
:target: https://travis-ci.org/GenericMappingTools/pygmt
15+
.. image:: https://img.shields.io/codecov/c/github/GenericMappingTools/pygmt/master.svg?style=flat-square
1616
:alt: Test coverage status
17-
:target: https://codecov.io/gh/GenericMappingTools/gmt-python
17+
:target: https://codecov.io/gh/GenericMappingTools/pygmt
1818
.. image:: https://img.shields.io/codacy/grade/e73169dcb8454b3bb0f6cc5389b228b4.svg?style=flat-square&label=codacy
1919
:alt: Code quality grade on codacy
20-
:target: https://www.codacy.com/app/leouieda/gmt-python
21-
.. image:: https://img.shields.io/pypi/pyversions/gmt-python.svg?style=flat-square
20+
:target: https://www.codacy.com/app/leouieda/pygmt
21+
.. image:: https://img.shields.io/pypi/pyversions/pygmt.svg?style=flat-square
2222
:alt: Compatible Python versions.
23-
:target: https://pypi.python.org/pypi/gmt-python
24-
.. image:: https://img.shields.io/gitter/room/GenericMappingTools/gmt-python.svg?style=flat-square
23+
:target: https://pypi.python.org/pypi/pygmt
24+
.. image:: https://img.shields.io/gitter/room/GenericMappingTools/pygmt.svg?style=flat-square
2525
:alt: Chat room on Gitter
26-
:target: https://gitter.im/GenericMappingTools/gmt-python
26+
:target: https://gitter.im/GenericMappingTools/pygmt
2727

2828

2929
.. placeholder-for-doc-index
@@ -39,14 +39,14 @@ ideas and implement new features. **This is NOT a finished product.**
3939

4040
We welcome any feedback and ideas!
4141
Let us know by submitting
42-
`issues on Github <https://github.com/GenericMappingTools/gmt-python/issues>`__
42+
`issues on Github <https://github.com/GenericMappingTools/pygmt/issues>`__
4343
or send us a message on our
44-
`Gitter chatroom <https://gitter.im/GenericMappingTools/gmt-python>`__.
44+
`Gitter chatroom <https://gitter.im/GenericMappingTools/pygmt>`__.
4545

4646
About
4747
-----
4848

49-
GMT/Python is a library for processing geospatial and geophysical data and making
49+
PyGMT is a library for processing geospatial and geophysical data and making
5050
publication quality maps and figures. It provides a Pythonic interface for the
5151
`Generic Mapping Tools (GMT) <https://github.com/GenericMappingTools/gmt>`__, a
5252
command-line program widely used in the Earth Sciences.
@@ -72,13 +72,13 @@ Contacting Us
7272
-------------
7373

7474
* Most discussion happens `on Github
75-
<https://github.com/GenericMappingTools/gmt-python>`__. Feel free to `open an issue
76-
<https://github.com/GenericMappingTools/gmt-python/issues/new>`__ or comment on any
75+
<https://github.com/GenericMappingTools/pygmt>`__. Feel free to `open an issue
76+
<https://github.com/GenericMappingTools/pygmt/issues/new>`__ or comment on any
7777
open issue or pull request.
78-
* We have a `chat room on Gitter <https://gitter.im/GenericMappingTools/gmt-python>`__
78+
* We have a `chat room on Gitter <https://gitter.im/GenericMappingTools/pygmt>`__
7979
where you can ask questions and leave comments.
8080
* This project is released with a `Contributor Code of Conduct
81-
<https://github.com/GenericMappingTools/gmt-python/blob/master/CODE_OF_CONDUCT.md>`__.
81+
<https://github.com/GenericMappingTools/pygmt/blob/master/CODE_OF_CONDUCT.md>`__.
8282
By participating in this project you agree to abide by its terms.
8383

8484

@@ -89,14 +89,14 @@ Code of conduct
8989
+++++++++++++++
9090

9191
Please note that this project is released with a `Contributor Code of Conduct
92-
<https://github.com/GenericMappingTools/gmt-python/blob/master/CODE_OF_CONDUCT.md>`__.
92+
<https://github.com/GenericMappingTools/pygmt/blob/master/CODE_OF_CONDUCT.md>`__.
9393
By participating in this project you agree to abide by its terms.
9494

9595
Contributing Guidelines
9696
+++++++++++++++++++++++
9797

9898
Please read our `Contributing Guide
99-
<https://github.com/GenericMappingTools/gmt-python/blob/master/CONTRIBUTING.md>`__ to
99+
<https://github.com/GenericMappingTools/pygmt/blob/master/CONTRIBUTING.md>`__ to
100100
see how you can help and give feedback.
101101

102102
Imposter syndrome disclaimer
@@ -140,6 +140,7 @@ Other Python wrappers for GMT:
140140
License
141141
-------
142142

143-
GMT/Python is free software: you can redistribute it and/or modify it under the terms of
143+
PyGMT is free software: you can redistribute it and/or modify it under the terms of
144144
the **BSD 3-clause License**. A copy of this license is provided in
145-
`LICENSE.txt <https://github.com/GenericMappingTools/gmt-python/blob/master/LICENSE.txt>`__.
145+
`LICENSE.txt <https://github.com/GenericMappingTools/pygmt/blob/master/LICENSE.txt>`__.
146+
.

0 commit comments

Comments
 (0)