Skip to content

Commit

Permalink
setup: Refine extra config requirements
Browse files Browse the repository at this point in the history
  • Loading branch information
tiagocoutinho committed Feb 9, 2021
1 parent 8b42470 commit 52e21fa
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 8 deletions.
11 changes: 5 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,10 @@
![License][license]

A simulator for real hardware. This project provides a server able to spawn
multiple simulated devices and serve requests concurrently
multiple simulated devices and serve requests concurrently.

This project provides only the required infrastructure to launch a server from
a configuration file (YAML, TOML or json) and a means to register third-party device plugins through
the python entry point mechanism.
a configuration file (YAML, TOML or json) and a means to register third-party device plugins through the python entry point mechanism.

So far, the project provides transports for TCP, UDP and serial line.
Support for new transports (ex: USB, GPIB or SPI) is being implemented on a
Expand All @@ -20,7 +19,7 @@ PRs are welcome!

## Installation

(**TL;DR**: `pip install sinstruments pyyaml toml`)
(**TL;DR**: `pip install sinstruments[all]`)

From within your favorite python environment:

Expand All @@ -31,13 +30,13 @@ $ pip install sinstruments
Additionally, if you want to write YAML configuration files in YAML:

```
$ pip install pyyaml
$ pip install sinstruments[yaml]
```

...or, for TOML based configuration:

```
$ pip install toml
$ pip install sinstruments[toml]
```

## Execution
Expand Down
11 changes: 9 additions & 2 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,13 @@
with open('README.md') as readme_file:
readme = readme_file.read()

requirements = [ 'gevent', 'PyYAML', 'enum34; python_version < "3.4"' ]
requirements = ['gevent']

extras = [
'yaml': ['PyYAML'],
'toml': ['toml'],
}
extras["all"] = list(set.union(*(set(i) for i in extras.values())))

setup_requirements = ['pytest-runner', ]

Expand All @@ -22,7 +28,7 @@
author="Tiago Coutinho",
author_email='[email protected]',
classifiers=[
'Development Status :: 2 - Pre-Alpha',
'Development Status :: 4 - Beta',
'Intended Audience :: Developers',
'License :: OSI Approved :: GNU General Public License v3 (GPLv3)',
'Natural Language :: English',
Expand All @@ -44,6 +50,7 @@
setup_requires=setup_requirements,
test_suite='tests',
tests_require=test_requirements,
extras_require=extras,
python_requires=">=3.5",
url='https://github.com/tiagocoutinho/sinstruments',
version='1.2.0',
Expand Down

0 comments on commit 52e21fa

Please sign in to comment.