Skip to content

Commit

Permalink
Installation script
Browse files Browse the repository at this point in the history
  • Loading branch information
0x9900 committed Dec 28, 2020
1 parent f23dd13 commit 8e11efb
Show file tree
Hide file tree
Showing 3 changed files with 63 additions and 1 deletion.
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
.DS_Store
*~
*.pyc
/pexec.egg-info/
/*.egg-info/
/build/
/dist/
upload.sh
19 changes: 19 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,25 @@ We have some PCB left. We are selling them for [$25 on tindie][1]
plan for your country and transmit on a frequency you are allowed to
use.**

## Intallation

The easiest way to install is program is to use the command `pip`. Pip
will automatically take care of installing the dependencies.

```
$ sudo pip install sa818
```

You can also clone this repository and use the setup.py script with
the following command. You will have to install the python package
`pyserial` manually. To install dependencies, refer to the manual of
your operating system.

```
$ git clone https://github.com/0x9900/SA818.git
$ sudo python3 setup.py install
```

## Example

```
Expand Down
42 changes: 42 additions & 0 deletions setup.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
#!/usr/bin/env python3
#
import sys

from setuptools import setup, find_packages

__doc__ = """
Use this software to program the frequency, ctcss, dcs and filters ont
the radio module SA818
"""
__author__ = "Fred C. (W6BSD)"
__version__ = '0.1.0'
__license__ = 'BSD'

py_version = sys.version_info[:2]
if py_version < (3, 5):
raise RuntimeError('SA818 requires Python 3.5 or later')

setup(
name='sa818',
version=__version__,
description='SA818 Programming Software',
long_description=__doc__,
url='https://github.com/0x9900/SA818/',
license=__license__,
author=__author__,
author_email='[email protected]',
py_modules=['sa818'],
install_requires=['pyserial'],
entry_points = {
'console_scripts': ['sa818 = sa818:main'],
},
classifiers=[
'Development Status :: 3 - Alpha',
'Intended Audience :: Developers',
'License :: OSI Approved :: BSD License',
'Operating System :: OS Independent',
'Programming Language :: Python',
'Programming Language :: Python :: 3',
'Programming Language :: Python :: 3.5'
],
)

0 comments on commit 8e11efb

Please sign in to comment.