SDOML dataset

SDOML is an open-source package for working with the SDOML Dataset (sdoml.org).

⚠️ This package is in development. Currently, it is intended for internal use only. The syntax is subject to change, and the documentation is incomplete. ⚠️

Installation

If you'd like to help develop the SDOML package, or just want to try out the package, you will need to install it from GitHub. The best way to do this is to create a new python virtual environment (either with pipenv or conda). Once you have that virtual environment:

$ git clone https://https://github.com/PaulJWright/sdoml.git
$ cd sdoml
$ pip install -e .

To install the optional extras required for testing, this can be performed with pip as below (for bash, and zsh)

$ pip install -e .[test]

~ pip install -e '.[test]'

pytest and coverage

coverage run -m pytest
coverage html

circleci

You can run circleci locally (https://circleci.com/docs/local-cli/), with brew, for example:

brew install circleci

and validate the file with

circleci config validate

License

This project is Copyright (c) Paul J. Wright and licensed under the terms of the Apache Software License 2.0 license. This package is based upon the Openastronomy packaging guide which is licensed under the BSD 3-clause licence. See the licenses folder for more information.

Contributing

We love contributions! sdoml is open source, built on open source, and we'd love to have you hang out in our community.

Imposter syndrome disclaimer: We want your help. No, really.

There may be a little voice inside your head that is telling you that you're not ready to be an open source contributor; that your skills aren't nearly good enough to contribute. What could you possibly offer a project like this one?

We assure you - the little voice in your head is wrong. If you can write code at all, you can contribute code to open source. Contributing to open source projects is a fantastic way to advance one's coding skills. Writing perfect code isn't the measure of a good developer (that would disqualify all of us!); it's trying to create something, making mistakes, and learning from those mistakes. That's how we all improve, and we are happy to help others learn.

Being an open source contributor doesn't just mean writing code, either. You can help out by writing documentation, tests, or even giving feedback about the project (and yes - that includes giving feedback about the contribution process). Some of these contributions may be the most valuable to the project as a whole, because you're coming to the project with fresh eyes, so you can see the errors and assumptions that seasoned contributors have glossed over.

Note: This disclaimer was originally written by Adrienne Lowe for a PyCon talk, and was adapted by sdoml based on its use in the README file for the MetPy project.