Skip to content

Commit

Permalink
pre-commit automated fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
7yl4r committed Aug 9, 2022
1 parent 311e6e2 commit 969058d
Show file tree
Hide file tree
Showing 34 changed files with 931 additions and 522 deletions.
12 changes: 6 additions & 6 deletions CONDUCT.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Contributor Code of Conduct

As contributors and maintainers of this project, we pledge to respect all people who
As contributors and maintainers of this project, we pledge to respect all people who
contribute through reporting issues, posting feature requests, updating documentation,
submitting pull requests or patches, and other activities.

Expand All @@ -13,13 +13,13 @@ imagery, derogatory comments or personal attacks, trolling, public or private ha
insults, or other unprofessional conduct.

Project maintainers have the right and responsibility to remove, edit, or reject comments,
commits, code, wiki edits, issues, and other contributions that are not aligned to this
Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed
commits, code, wiki edits, issues, and other contributions that are not aligned to this
Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed
from the project team.

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by
opening an issue or contacting one or more of the project maintainers.

This Code of Conduct is adapted from the Contributor Covenant
(http:contributor-covenant.org), version 1.0.0, available at
This Code of Conduct is adapted from the Contributor Covenant
(http:contributor-covenant.org), version 1.0.0, available at
http://contributor-covenant.org/version/1/0/0/
8 changes: 4 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# Contributing to pyobis
## Why contribute to the Open Source?
Contributing to the Open Source is a good way to learn, practice and build experience in every skill you want in life (both soft and hard), if not the best way.
Contributing to the Open Source is a good way to learn, practice and build experience in every skill you want in life (both soft and hard), if not the best way.
+ You get the chance to improve the software you rely on, or *the world relies on*.
+ It helps you improve existing skills, in an exponential manner.
+ You not only get to meet people who are really interested in similar things but are also really cool.
+ You get the chance to find mentors and even teach others.
+ You get the chance to find mentors and even teach others.
+ You get the feeling of being in a community that's interesting and as good as anything. It feels empowered when you make changes (even smaller ones).
+ You don't always have to code, you can suggest some great ideas or fix a typo in the documentation.

Expand Down Expand Up @@ -47,7 +47,7 @@ We use GitHub issues to track public bugs. Report a bug by [opening a new issue]
- A quick summary and/or background
- Steps to reproduce
- Be specific!
- Give sample code if you can, so that *anyone* with the base python setup can reproduce.
- Give sample code if you can, so that *anyone* with the base python setup can reproduce.
- What you expected would happen
- What actually happens
- Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)
Expand All @@ -69,4 +69,4 @@ There are really great resources out there to help you become a successful contr
+ [Zen of Scientific Software Maintenance](https://jrleeman.github.io/ScientificSoftwareMaintenance/)

## References
This document was adapted from the open-source contribution guidelines for [Facebook's Draft](https://github.com/facebook/draft-js/blob/a9316a723f9e918afde44dea68b5f9f39b7d9b00/CONTRIBUTING.md) with some changes inspired from [MetPy's guide](https://github.com/Unidata/MetPy/blob/main/CONTRIBUTING.md).
This document was adapted from the open-source contribution guidelines for [Facebook's Draft](https://github.com/facebook/draft-js/blob/a9316a723f9e918afde44dea68b5f9f39b7d9b00/CONTRIBUTING.md) with some changes inspired from [MetPy's guide](https://github.com/Unidata/MetPy/blob/main/CONTRIBUTING.md).
35 changes: 21 additions & 14 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Main Features
Here are just a few of things pyOBIS can do:

* Easy handling of OBIS data, easy fetching without handling the raw API response directly.
* Built-in functions for ``occurrence``, ``taxon``, ``node``, ``checklist`` and ``dataset`` endpoints of OBIS API.
* Built-in functions for ``occurrence``, ``taxon``, ``node``, ``checklist`` and ``dataset`` endpoints of OBIS API.
* Provides easy export of data to ``Pandas`` DataFrame, and helps researchers focus more on analysis rather than data mining.

For examples of how to use this repo, see the jupyter notebooks in the ``/notebooks/`` directory.
Expand Down Expand Up @@ -58,8 +58,8 @@ Install editable dev version from github for local development. System prerequis
cd pyobis
# install
python -m pip install -r requirements.txt
python -m pip install -r requirements-dev.txt
python -m pip install -e .
python -m pip install -r requirements-dev.txt
python -m pip install -e .
# test your installation
python -m pytest
# test and generate a coverage report
Expand Down Expand Up @@ -88,9 +88,10 @@ Taxa module
.. code-block:: python
from pyobis import taxa
taxa.search(scientificname = "Mola mola")
taxa.search(scientificname = "Mola mola", offset=10)
taxa.search(geometry='POLYGON((30.1 10.1, 10 20, 20 40, 40 40, 30.1 10.1))')
taxa.search(scientificname="Mola mola")
taxa.search(scientificname="Mola mola", offset=10)
taxa.search(geometry="POLYGON((30.1 10.1, 10 20, 20 40, 40 40, 30.1 10.1))")
taxa.taxon(10332)
taxa.taxon(127405)
Expand All @@ -100,34 +101,40 @@ Occurrence module
.. code-block:: python
from pyobis import occurrences
occurrences.search(scientificname = "Mola mola")
occurrences.search(scientificname = "Mola mola", offset=0, size=10)
occurrences.search(geometry="POLYGON((30.1 10.1, 10 20, 20 40, 40 40, 30.1 10.1))", size=20)
occurrences.search(scientificname="Mola mola")
occurrences.search(scientificname="Mola mola", offset=0, size=10)
occurrences.search(
geometry="POLYGON((30.1 10.1, 10 20, 20 40, 40 40, 30.1 10.1))", size=20
)
Dataset module
##############

.. code-block:: python
from pyobis import dataset
dataset.search(scientificname = ["Mola", "Abra", "Lanice", "Pectinaria"])
dataset.get(id = "ec9df3b9-3b2b-4d83-881b-27bcbcd57b95")
dataset.search(scientificname=["Mola", "Abra", "Lanice", "Pectinaria"])
dataset.get(id="ec9df3b9-3b2b-4d83-881b-27bcbcd57b95")
Nodes module
############

.. code-block:: python
from pyobis import nodes
nodes.search(scientificname = ["Mola", "Abra"] )
nodes.search(scientificname=["Mola", "Abra"])
Checklist module
################

.. code-block:: python
from pyobis import checklist as ch
ch.list(scientificname = "Cetacea")
ch.list(scientificname="Cetacea")
Usage Guide
===========
Expand Down Expand Up @@ -160,4 +167,4 @@ Further Reading
:target: http://pyobis.readthedocs.org/en/latest/?badge=latest

.. |tests| image:: https://github.com/iobis/pyobis/actions/workflows/tests.yml/badge.svg
:target: https://github.com/iobis/pyobis/actions/workflows/tests.yml
:target: https://github.com/iobis/pyobis/actions/workflows/tests.yml
2 changes: 1 addition & 1 deletion docs/checklist.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,4 @@ checklist module
.. automethod:: checklist.list
.. automethod:: checklist.redlist
.. automethod:: checklist.newest
.. automethod:: checklist.newest
Loading

0 comments on commit 969058d

Please sign in to comment.