Skip to content

Commit

Permalink
Migrate pyHydrabus to its own repository
Browse files Browse the repository at this point in the history
  • Loading branch information
Baldanos committed Apr 1, 2020
1 parent aab8247 commit 4a329da
Show file tree
Hide file tree
Showing 5 changed files with 45 additions and 3 deletions.
23 changes: 23 additions & 0 deletions .readthedocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# .readthedocs.yml
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

# Required
version: 2

# Build documentation in the docs/ directory with Sphinx
sphinx:
configuration: docs/source/conf.py

# Build documentation with MkDocs
#mkdocs:
# configuration: mkdocs.yml

# Optionally build your docs in additional formats such as PDF and ePub
formats: all

# Optionally set the version of Python and requirements required to build your docs
python:
version: 3.6
install:
- requirements: requirements.txt
20 changes: 19 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,33 @@
# pyHydrabus

A python (3.6+) module that can be used to control the Hydrabus from a Python script.
A python (3.6+) module that can be used to control the [HydraFW](https://github.com/hydrabus/hydrafw) from a Python script.

## Installing

### From source

Clone this repository, then run the following command :

```
$ python setup.py install --user
```

### From Pypi

pyHydrabus is also available on [Pypi](https://pypi.org/project/pyHydrabus/)

```
$ pip install pyHydrabus
```

## Usage

### ReadTheDocs

The documentation is available [online](https://pyhydrabus.readthedocs.io/en/latest/).

### Sphinx

The library is self-documented using docstrings.
The API documentation is also available using [Sphinx](http://www.sphinx-doc.org).

Expand Down
2 changes: 1 addition & 1 deletion pyHydrabus/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -30,4 +30,4 @@
OUTPUT = 0

name = "pyHydrabus"
__version__ = 0.2
__version__ = "0.2.1"
1 change: 1 addition & 0 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
pyserial
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
description="Hydrabus BBIO python bindings",
long_description=long_description,
long_description_content_type="text/markdown",
url="https://github.com/hydrabus/hydrafw",
url="https://github.com/hydrabus/pyhydrabus",
packages=setuptools.find_packages(),
install_requires=['pyserial'],
classifiers=[
Expand Down

0 comments on commit 4a329da

Please sign in to comment.