fatiando / maintenance Goto Github PK

Description

Extend support of all our libraries to Python 3.9. This involves:

1. Adding CI jobs with Python 3.9 so we know things work. This usually only involves adding "3.9" to the list of Python versions in the configuration files.
2. Add the 3.9 tag to setup.py

Apply changes to

Libraries:

• boule
• erizo
• harmonica
• pooch
• rockhound
• verde

Other repositories:

• .github
• contributing
• continuous-integration

Further instructions

In order to solve this issue we need to start opening Pull Requests on each
repository listed above. Optionally, we can open Issues on each repository if
further discussion specific to that repository is needed.

Remember to mention this Issue on every Issue or Pull Request opened on each
repository for keeping a record by adding something like:

Related to fatiando/maintenance#XX

A quick checklist:

1. Open an Issue on each repository listed above (optional). Mention this Issue
   on them.
2. Open a Pull Request on the same repository to tackle the Issue. Mention this
   Issue on them.
3. Check-off the repository on the list above once the Pull Request is merged.
4. Close this issue when all items are checked-off.

We want your help

We know that maintenance tasks are very demanding, so we don't expect a single
person to tackle this issue by themselves. Any help is very welcomed, so please
comment below that you want to take care of the changes on any repository and
we will assign it to you.

Description

We need to add a copyright notice and license information (name and terms) to every .py file. This can be found in the LICENSE files of each repository. The notice should be put in a comment at the top of the files:

# Copyright (c) YEAR The PROJECT Developers.
# Distributed under the terms of the BSD 3-Clause License.
# SPDX-License-Identifier: BSD-3-Clause
#
# This code is part of the Fatiando a Terra project (https://www.fatiando.org)
#

This is how MetPy does it.

I never thought that this was a big deal but I have since changed my mind. A couple of months ago I came across this repository: https://github.com/igp-gravity/geoist. Shockingly, it includes most files from fatiando/fatiando and fatiando/verde without any mention or attribution. Some files even go so far as to claim authorship for the code (for example, the old code for coordinate generation). I have opened igp-gravity/geoist#7 to raise the issue of violation of our license terms and got a reply but so far nothing has happened. I don't particularly mind them reusing the fatiando/fatiando code since we're not updating it anymore but I was really bothered by the lack of attribution and copying Verde.

The package seems to include a whole bunch of code from other people just blatantly copied, some with the copyright and attribution intact (at least they didn't remove existing notices). This is what prompted this maintenance task. If we had the notice on our files, some of the bad feelings this generated might have been avoided. Though copying code instead of linking (importing) from active projects like Verde is generally frowned upon, it's prohibited by open-source licenses.

Apply changes to

Libraries:

• boule
• erizo
• harmonica
• pooch
• rockhound
• verde

Other repositories:

• rockhound-data

Further instructions

In order to solve this issue we need to start opening Pull Requests on each
repository listed above. Optionally, we can open Issues on each repository if
further discussion specific to that repository is needed.

Remember to mention this Issue on every Issue or Pull Request opened on each
repository for keeping a record by adding something like:

Related to fatiando/maintenance#XX

A quick checklist:

1. Open an Issue on each repository listed above (optional). Mention this Issue
   on them.
2. Open a Pull Request on the same repository to tackle the Issue. Mention this
   Issue on them.
3. Check-off the repository on the list above once the Pull Request is merged.
4. Close this issue when all items are checked-off.

We want your help

We know that maintenance tasks are very demanding, so we don't expect a single
person to tackle this issue by themselves. Any help is very welcomed, so please
comment below that you want to take care of the changes on any repository and
we will assign it to you.

Description

Our license files mostly state a year range for the copyright notice. This seems to be unnecessary: https://softwareengineering.stackexchange.com/questions/130478/what-copyright-date-for-an-update-to-an-open-source-project-from-last-year

We can remove the second part, leaving only the year of first publication in the file. That will also keep us from having to update this all the time.

Apply changes to

Libraries:

• boule
• erizo
• harmonica
• pooch
• rockhound
• verde

Other repositories:

• continuous-integration

Further instructions

In order to solve this issue we need to start opening Pull Requests on each
repository listed above. Optionally, we can open Issues on each repository if
further discussion specific to that repository is needed.

Remember to mention this Issue on every Issue or Pull Request opened on each
repository for keeping a record by adding something like:

Related to fatiando/maintenance#XX

A quick checklist:

1. Open an Issue on each repository listed above (optional). Mention this Issue
   on them.
2. Open a Pull Request on the same repository to tackle the Issue. Mention this
   Issue on them.
3. Check-off the repository on the list above once the Pull Request is merged.
4. Close this issue when all items are checked-off.

We want your help

We know that maintenance tasks are very demanding, so we don't expect a single
person to tackle this issue by themselves. Any help is very welcomed, so please
comment below that you want to take care of the changes on any repository and
we will assign it to you.

Description of the desired feature

After last community call, we decided to move all our automated CIs to GitHub Actions.
Actions work faster than Travis and Azure with much easier configuration, specially for deployment and key managements.
The visualization of the processes is also better because it's integrated into GitHub, including also errors raising on the workflow configuration file, which makes much easier to debug the workflows.

Currently Pooch has already made the change, so we need to do the same on:

• harmonica
• verde
• rockhound
• boule
• contributing

Feel free to open PRs on each repository and ping this issue on it.

Description

Nox is a tool that automates setting up virtual environments and running tasks inside them. It's a combination of make and virtual environments. Replace the machinery in our Makefile (which wouldn't work on Windows) with a cross-platform noxfile.py. Since nox handles the virtual environments, the environment.yml only needs to have python and nox. Plus, the environment creation code in the CI is no necessary anymore and we can run tests on multiple python versions locally as well.

This was tested in fatiando/boule#59 and seems to work very well.

Apply changes to

Libraries:

• boule
• erizo (partly done but needs updating)
• harmonica
• pooch
• rockhound
• verde

Further instructions

In order to solve this issue we need to start opening Pull Requests on each
repository listed above. Optionally, we can open Issues on each repository if
further discussion specific to that repository is needed.

Remember to mention this Issue on every Issue or Pull Request opened on each
repository for keeping a record by adding something like:

Related to fatiando/maintenance#XX

A quick checklist:

1. Open an Issue on each repository listed above (optional). Mention this Issue
   on them.
2. Open a Pull Request on the same repository to tackle the Issue. Mention this
   Issue on them.
3. Check-off the repository on the list above once the Pull Request is merged.
4. Close this issue when all items are checked-off.

We want your help

We know that maintenance tasks are very demanding, so we don't expect a single
person to tackle this issue by themselves. Any help is very welcomed, so please
comment below that you want to take care of the changes on any repository and
we will assign it to you.

Description

The new setuptools-scm allows to obtain the Semver version of any library through VCS by just installing the setuptools-scm package through pip or conda and then adding some configuration lines on the files used to install the library.
We were already doing the same thing through versioneer, although it needed us to copy and paste some large files that don't get automatic updates.

I've already experimented with the replacement on Harmonica, so please take a look at fatiando/harmonica#196 before implementing the same changes on every library.

We know that maintenance tasks are very demanding, so we don't expect a single
person to tackle this issue by themselves. Any help is very welcomed, so please
comment below that you want to take care of the changes on any repository and
we will assign it to you.

Apply changes to

Libraries:

• boule
• erizo
• harmonica
• pooch
• rockhound
• verde
• contributing

Further instructions

In order to solve this issue we need to start opening Pull Requests on each
repository listed above. Optionally, we can open Issues on each repository if
further discussion specific to that repository is needed.

Remember to mention this Issue on every Issue or Pull Request opened on each
repository for keeping a record by adding something like:

Related to fatiando/maintenance#4

A quick checklist:

1. Open an Issue on each repository listed above (optional). Mention this Issue
   on them.
2. Open a Pull Request on the same repository to tackle the Issue. Mention this
   Issue on them.
3. Check-off the repository on the list above once the Pull Request is merged.
4. Close this issue when all items are checked-off.