Skip to content

Commit

Permalink
revised README
Browse files Browse the repository at this point in the history
  • Loading branch information
mdklatt committed Jul 25, 2017
1 parent 18713c2 commit 6025b8e
Show file tree
Hide file tree
Showing 3 changed files with 34 additions and 36 deletions.
4 changes: 2 additions & 2 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## Travis CI configuration for the serial-core library.
##
## <https://travis-ci.org/mdklatt/serial-python>
## <https://travis-ci.org/mdklatt/serial-python>
##
language: python

Expand All @@ -18,4 +18,4 @@ install:
- pip install . -r test/requirements.txt

script:
- py.test --verbose test/
- pytest --verbose test/
64 changes: 31 additions & 33 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,32 +1,35 @@
Overview |travis.png|
---------------------
===========
serial-core
===========
.. |travis.png| image:: https://travis-ci.org/mdklatt/cookiecutter-python-lib.png?branch=master
:alt: Travis CI build status
:target: `travis`_
.. _travis: https://travis-ci.org/mdklatt/serial-python
.. _serial: http://github.com/mdklatt/serial-python


|travis.png|


The `serial`_ Python library provides extensible tools for reading and writing
record-oriented data in various formats. The core library provided here is
contained in the ``serial.core`` package. Library extensions will be contained
in their own packages under the ``serial`` namespace.


.. |travis.png| image:: https://travis-ci.org/mdklatt/cookiecutter-python-lib.png?branch=master
:alt: Travis CI build status
:target: `travis`_
.. _travis: https://travis-ci.org/mdklatt/serial-python
.. _serial: http://github.com/mdklatt/serial-python


Features
--------
* Read/write delimited and fixed-width data
* Named, typed, and formatted data fields
* Filtering
* Aggregation
* Sorting
========
- Read/write delimited and fixed-width data
- Named, typed, and formatted data fields
- Filtering
- Aggregation
- Sorting


Basic Example
-------------
=============

.. code-block::
.. code-block:: python
""" Read a comma-delimited file.
Expand All @@ -50,29 +53,24 @@ Basic Example
Requirements
------------
============
.. _Sphinx: http://sphinx-doc.org
.. _pytest: http://pytest.org

Python 2.7 is required. While an attempt has been made to maximize forward
compatibility with Python 3.3+, this has not been tested.
compatibility with Python 3, this is not guaranteed.

Packages
~~~~~~~~
* `Sphinx`_ (optional; required to build documentation)
* `py.test`_ (optional; required to run test suite)
- `Sphinx`_ (optional; required to build documentation)
- `pytest`_ (optional; required to run test suite)


.. _Sphinx: http://sphinx-doc.org
.. _py.test: http://pytest.org


Installation
------------

Install the library from GitHub:
============
.. _GitHub: https://github.com/mdklatt/serial-python

.. code-block::
$ pip install git+git://github.com/mdklatt/serial-python.git
Install the library from `GitHub`_:

.. code-block:: shell
.. _GitHub: https://github.com/mdklatt/serial-python
$ pip install git+git://github.com/mdklatt/serial-python.git
2 changes: 1 addition & 1 deletion src/serial/core/__version__.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,4 @@
and backwards compatibility is not guaranteed for minor versions.
"""
__version__ = "0.6.4dev1"
__version__ = "0.6.4dev2"

0 comments on commit 6025b8e

Please sign in to comment.