Skip to content

Commit f87f798

Browse files
wtolsonwtolson
committed
Extract pvl label parser from pysis.
1 parent cff826b commit f87f798

29 files changed

+2940
-2
lines changed

‎.travis.yml

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Config file for automatic testing at travis-ci.org
2+
3+
language: python
4+
5+
python:
6+
- "3.4"
7+
- "3.3"
8+
- "2.7"
9+
- "2.6"
10+
- "pypy"
11+
12+
# command to install dependencies, e.g. pip install -r requirements.txt --use-mirrors
13+
install: pip install -r requirements.txt
14+
15+
# command to run tests, e.g. python setup.py test
16+
script: py.test tests

‎AUTHORS.rst

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
=======
2+
Credits
3+
=======
4+
5+
Development Lead
6+
----------------
7+
8+
* Trevor Olson <[email protected]>
9+
10+
Contributors
11+
------------
12+
13+
* Sarah Braden <[email protected]>
14+
* Michael Aye <[email protected]>

‎CONTRIBUTING.rst

+111
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,111 @@
1+
============
2+
Contributing
3+
============
4+
5+
Contributions are welcome, and they are greatly appreciated! Every
6+
little bit helps, and credit will always be given.
7+
8+
You can contribute in many ways:
9+
10+
Types of Contributions
11+
----------------------
12+
13+
Report Bugs
14+
~~~~~~~~~~~
15+
16+
Report bugs at https://github.com/planetarypy/pvl/issues.
17+
18+
If you are reporting a bug, please include:
19+
20+
* Your operating system name and version.
21+
* Any details about your local setup that might be helpful in troubleshooting.
22+
* Detailed steps to reproduce the bug.
23+
24+
Fix Bugs
25+
~~~~~~~~
26+
27+
Look through the GitHub issues for bugs. Anything tagged with "bug"
28+
is open to whoever wants to implement it.
29+
30+
Implement Features
31+
~~~~~~~~~~~~~~~~~~
32+
33+
Look through the GitHub issues for features. Anything tagged with "feature"
34+
is open to whoever wants to implement it.
35+
36+
Write Documentation
37+
~~~~~~~~~~~~~~~~~~~
38+
39+
pvl could always use more documentation, whether as part of the
40+
official pvl docs, in docstrings, or even on the web in blog posts,
41+
articles, and such.
42+
43+
Submit Feedback
44+
~~~~~~~~~~~~~~~
45+
46+
The best way to send feedback is to file an issue at https://github.com/planetarypy/pvl/issues.
47+
48+
If you are proposing a feature:
49+
50+
* Explain in detail how it would work.
51+
* Keep the scope as narrow as possible, to make it easier to implement.
52+
* Remember that this is a volunteer-driven project, and that contributions
53+
are welcome :)
54+
55+
Get Started!
56+
------------
57+
58+
Ready to contribute? Here's how to set up `pvl` for local development.
59+
60+
1. Fork the `pvl` repo on GitHub.
61+
2. Clone your fork locally::
62+
63+
$ git clone [email protected]:your_name_here/pvl.git
64+
65+
3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development::
66+
67+
$ mkvirtualenv pvl
68+
$ cd pvl/
69+
$ pip install -r requirements.txt
70+
71+
4. Create a branch for local development::
72+
73+
$ git checkout -b name-of-your-bugfix-or-feature
74+
75+
Now you can make your changes locally.
76+
77+
5. When you're done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox::
78+
79+
$ make lint
80+
$ make test
81+
$ make test-all
82+
83+
To get flake8 and tox, just pip install them into your virtualenv.
84+
85+
6. Commit your changes and push your branch to GitHub::
86+
87+
$ git add .
88+
$ git commit -m "Your detailed description of your changes."
89+
$ git push origin name-of-your-bugfix-or-feature
90+
91+
7. Submit a pull request through the GitHub website.
92+
93+
Pull Request Guidelines
94+
-----------------------
95+
96+
Before you submit a pull request, check that it meets these guidelines:
97+
98+
1. The pull request should include tests.
99+
2. If the pull request adds functionality, the docs should be updated. Put
100+
your new functionality into a function with a docstring, and add the
101+
feature to the list in README.rst.
102+
3. The pull request should work for Python 2.6, 2.7, and 3.3, 3.4, and for PyPy. Check
103+
https://travis-ci.org/planetarypy/pvl/pull_requests
104+
and make sure that the tests pass for all supported Python versions.
105+
106+
Tips
107+
----
108+
109+
To run a subset of tests::
110+
111+
$ py.test tests/test_pvl.py

‎HISTORY.rst

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
.. :changelog:
2+
3+
History
4+
-------
5+
6+
0.1.0 (2015-05-30)
7+
~~~~~~~~~~~~~~~~~~
8+
9+
* First release on PyPI.

‎MANIFEST.in

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
include AUTHORS.rst
2+
include CONTRIBUTING.rst
3+
include HISTORY.rst
4+
include LICENSE
5+
include README.rst
6+
7+
recursive-include tests *
8+
recursive-exclude * __pycache__
9+
recursive-exclude * *.py[co]
10+
11+
recursive-include docs *.rst conf.py Makefile make.bat

‎Makefile

+58
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
.PHONY: clean-pyc clean-build docs clean
2+
3+
help:
4+
@echo "clean-build - remove build artifacts"
5+
@echo "clean-pyc - remove Python file artifacts"
6+
@echo "lint - check style with flake8"
7+
@echo "test - run tests quickly with the default Python"
8+
@echo "test-all - run tests on every Python version with tox"
9+
@echo "coverage - check code coverage quickly with the default Python"
10+
@echo "docs - generate Sphinx HTML documentation, including API docs"
11+
@echo "release - package and upload a release"
12+
@echo "dist - package"
13+
14+
clean: clean-build clean-pyc
15+
rm -fr htmlcov/
16+
17+
clean-build:
18+
rm -fr build/
19+
rm -fr dist/
20+
rm -fr *.egg-info
21+
22+
clean-pyc:
23+
find . -name '*.pyc' -exec rm -f {} +
24+
find . -name '*.pyo' -exec rm -f {} +
25+
find . -name '__pycache__' -exec rm -rf {} +
26+
find . -name '*~' -exec rm -f {} +
27+
28+
lint:
29+
flake8 pvl tests
30+
31+
test:
32+
py.test
33+
34+
test-all:
35+
tox
36+
37+
coverage:
38+
coverage run --source pvl py.test
39+
coverage report -m
40+
coverage html
41+
open htmlcov/index.html
42+
43+
docs:
44+
rm -f docs/pvl.rst
45+
rm -f docs/modules.rst
46+
sphinx-apidoc -o docs/ pvl
47+
$(MAKE) -C docs clean
48+
$(MAKE) -C docs html
49+
open docs/_build/html/index.html
50+
51+
release: clean
52+
python setup.py sdist upload
53+
python setup.py bdist_wheel upload
54+
55+
dist: clean
56+
python setup.py sdist
57+
python setup.py bdist_wheel
58+
ls -l dist

‎README.md

-2
This file was deleted.

‎README.rst

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
===============================
2+
pvl
3+
===============================
4+
5+
.. image:: https://badge.fury.io/py/pvl.svg
6+
:target: http://badge.fury.io/py/pvl
7+
8+
.. image:: https://travis-ci.org/planetarypy/pvl.svg?branch=master
9+
:target: https://travis-ci.org/planetarypy/pvl
10+
11+
.. image:: https://pypip.in/d/pvl/badge.png
12+
:target: https://pypi.python.org/pypi/pvl
13+
14+
15+
Python implementation of PVL (Parameter Value Language)
16+
17+
* Free software: BSD license
18+
* Documentation: http://pvl.readthedocs.org.
19+
20+
Features
21+
--------
22+
23+
* TODO

0 commit comments

Comments
 (0)