Skip to content
This repository was archived by the owner on Apr 13, 2021. It is now read-only.

Commit e2ee49b

Browse files
committed
Python packaging cleanup.
Updates Python package conventions. Does some setup so that setup tools can use the current version of libswiftnav in the repository. /cc @mfine @fnoble @benjamin0
1 parent 953c6d6 commit e2ee49b

File tree

9 files changed

+198
-639
lines changed

9 files changed

+198
-639
lines changed

python/.gitignore

Lines changed: 59 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,62 @@
11
RELEASE-VERSION
2-
*.c
3-
*.pyc
4-
build/
5-
docs/_build/
6-
.DS_Store
7-
*.egg*
8-
*.so
92
docs/libswiftnav.tag
103
docs/swiftnav.rst
11-
distribute*.tar.gz
4+
swiftnav/*.c
5+
6+
.DS_Store
7+
*.*~
8+
9+
# Byte-compiled / optimized / DLL files
10+
__pycache__/
11+
*.py[cod]
12+
13+
# C extensions
14+
*.so
15+
16+
# Distribution / packaging
17+
.Python
18+
env/
19+
build/
20+
develop-eggs/
21+
dist/
22+
downloads/
23+
eggs/
24+
lib/
25+
lib64/
26+
parts/
27+
sdist/
28+
var/
29+
*.egg-info/
30+
.installed.cfg
31+
*.egg
32+
33+
# PyInstaller
34+
# Usually these files are written by a python script from a template
35+
# before PyInstaller builds the exe, so as to inject date/other infos into it.
36+
*.manifest
37+
*.spec
38+
39+
# Installer logs
40+
pip-log.txt
41+
pip-delete-this-directory.txt
42+
43+
# Unit test / coverage reports
44+
htmlcov/
45+
.tox/
46+
.coverage
47+
.cache
48+
nosetests.xml
49+
coverage.xml
50+
51+
# Translations
52+
*.mo
53+
*.pot
54+
55+
# Sphinx documentation
56+
docs/_build/
57+
58+
# PyBuilder
59+
target/
60+
61+
# Virtual Envs
62+
/*env

python/MANIFEST.in

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
include *.cfg
2+
include *.md
3+
include *.rst
4+
include *.py
5+
include *.sh
6+
include *.txt
7+
include .coveragerc
8+
include .gitignore
9+
include LICENSE
10+
include LICENSE.GPLv3
11+
include tox.ini
12+
recursive-include libswiftnav/ *
13+
prune libswiftnav/build/
14+
recursive-include swiftnav/ *.py
15+
recursive-include swiftnav/ *.pyx
16+
recursive-include swiftnav/ *.pyd
17+
prune docs/_build

python/README.rst

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
==================
2+
libswiftnav-python
3+
==================
4+
5+
Python bindings to the `libswiftnav
6+
<http://github.com/swift-nav/libswiftnav>`_ GNSS library. Full
7+
documentation is available online at
8+
http://docs.swift-nav.com/libswiftnav-python.
9+
10+
Installation
11+
============
12+
13+
Obtaining the source
14+
--------------------
15+
16+
The libswiftnav-python source and release tarballs are available from
17+
GitHub, https://github.com/swift-nav/libswiftnav-python. The latest
18+
development version of libswiftnav-python can be cloned from github
19+
using this command::
20+
21+
$ git clone git://github.com/swift-nav/libswiftnav-python.git
22+
23+
Requirements
24+
--------------------
25+
26+
libswiftnav-python requires libswiftnav C libary available at
27+
`libswiftnav <https://github.com/swift-nav/libswiftnav>`_.
28+
29+
The Python dependencies are included in ``requirements.txt``, which
30+
you can install via::
31+
32+
$ (sudo) pip install -r requirements
33+
34+
Building and Installing
35+
-----------------------
36+
37+
To install libswiftnav-python (from the root of the source tree)::
38+
39+
$ python setup.py build
40+
$ (sudo) python setup.py install
41+
42+
Building Documentation
43+
----------------------
44+
45+
Building the documentation requires the libswiftnav-python source code
46+
and some additional packages:
47+
48+
- `Sphinx <http://sphinx.pocoo.org>`_ (and its dependencies) 1.0 or later
49+
- `numpydoc <http://pypi.python.org/pypi/numpydoc>`_ 0.4 or later
50+
- `matplotlib <http://matplotlib.org/>`_ 1.1 or later
51+
- `IPython <http://ipython.org/>`_ 0.13.1 or later
52+
- `sphinx-doxylink <http://pypi.python.org/pypi/sphinxcontrib-doxylink>`_
53+
1.3 or later
54+
55+
To build the libswiftnav-python documentation, execute the following commands::
56+
57+
$ cd docs
58+
$ make html
59+
60+
The documentation will be built in the ``docs/_build/html`` directory, and can
61+
be read by pointing a web browser to ``docs/_build/html/index.html``.

0 commit comments

Comments
 (0)