Skip to content
This repository was archived by the owner on Oct 24, 2019. It is now read-only.

Commit 24b31c9

Browse files
committed
Retrieved README from develop
Will need to update links after merging PR
1 parent 82cb5a9 commit 24b31c9

File tree

2 files changed

+38
-4
lines changed

2 files changed

+38
-4
lines changed

README.md

Lines changed: 0 additions & 4 deletions
This file was deleted.

README.rst

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
|pyautoupdate_logo|
2+
3+
``pyautoupdate`` is a python wrapper that allows the wrapped code to
4+
automatically update.
5+
6+
|Build_Status| |Codecov_Status|
7+
8+
**Note: This is pre-alpha code. The update functionality does not work
9+
yet.**
10+
11+
Advantages
12+
----------
13+
14+
- This module is written in pure python. **This means that there is no
15+
need to have a C compiler to use this module.**
16+
- pyautoupdate works with both python 2 and 3
17+
- pypy and pypy3 can also be used
18+
19+
Dependencies
20+
------------
21+
22+
- For python 2, python 2.6 or later is required
23+
- For python 3, python 3.3 or later is required
24+
- ``requests`` for retrieving updated versions
25+
- ``pytest`` for running the tests
26+
- ``pytest_cov`` to measure coverage
27+
- ``pylint`` for code style checks
28+
29+
License
30+
-------
31+
32+
LGPL 2.1
33+
34+
.. |pyautoupdate_logo| image:: https://cloud.githubusercontent.com/assets/14067959/13902076/25e8305e-edf7-11e5-873c-8a4e0fc2780f.png
35+
.. |Build_Status| image:: https://travis-ci.org/rlee287/pyautoupdate.svg?branch=develop
36+
:target: https://travis-ci.org/rlee287/pyautoupdate
37+
.. |Codecov_Status| image:: http://codecov.io/github/rlee287/pyautoupdate/coverage.svg?branch=develop
38+
:target: http://codecov.io/github/rlee287/pyautoupdate?branch=develop

0 commit comments

Comments
 (0)