Skip to content
This repository was archived by the owner on Apr 5, 2021. It is now read-only.

Commit f2690e0

Browse files
committed
updates for 0.8.2 release, incluing PyPi support
1 parent 5dcb819 commit f2690e0

File tree

4 files changed

+31
-59
lines changed

4 files changed

+31
-59
lines changed

.gitignore

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,7 @@
11
__pycache__
2+
Pipfile
23
Pipfile.lock
4+
scratch*
5+
.idea
6+
build
7+
dist

Pipfile

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

README.md

Lines changed: 12 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Does it work for your model as well? Join the discussion on the
1313
[sucks-users mailing
1414
list](https://groups.google.com/forum/#!forum/sucks-users).
1515

16-
If you're curious about the protocol, I have [a rough doc](protocol.md)
16+
If you're curious about the protocol, I have [a rough doc](http://github.com/wpietri/sucks/blob/master/protocol.md)
1717
started. I'll happily accept pull requests for it.
1818

1919
Why the project name? Well, a) it's ridiculous that I needed to MITM
@@ -23,15 +23,14 @@ it's a vacuum.
2323

2424
## Installation
2525

26-
Check out this code, possibly create a virtualenv, and do
27-
`pip install pipenv; pip install -e .`. If that doesn't work for
28-
you, please [open an issue](https://github.com/wpietri/sucks/issues).
26+
If you have a recent version of python, you should be able to
27+
do `pip install sucks` to get the most recently released version of
28+
this.
2929

3030
## Usage
3131

3232
To get started, you'll need to have already set up an EcoVacs account
33-
using your smartphone. I've only tested this with Android, but I expect
34-
it will work with iPhone-created accounts as well.
33+
using your smartphone.
3534

3635
Step one is to log in:
3736
```
@@ -44,7 +43,8 @@ Step one is to log in:
4443
```
4544

4645
That creates a config file in ~/.config.sucks.conf. The password is
47-
hashed before saving, so it's reasonably safe.
46+
hashed before saving, so it's reasonably safe. (If it doesn't appear
47+
to work for your continent, try "ww", their world-wide catchall.)
4848

4949
With that set up, you could have it clean in auto mode for 10 minutes
5050
and return to its charger:
@@ -83,7 +83,7 @@ so it also has a mode where it randomly decides to run or not based on
8383
a frequency you give it. My crontab entry looks like this:
8484

8585
```
86-
0 10 * * * /home/william/projects/sucks/sucks clean -f 4/7 15 edge -f 1/14 10
86+
0 10 * * * /home/william/projects/sucks/sucks.sh clean -f 4/7 15 edge -f 1/14 10
8787
```
8888

8989
This means that every day at 10 am, it might do something. 4 days out
@@ -118,9 +118,9 @@ vacbot.run(Charge()) # return to the charger
118118
## Developing
119119

120120
If you'd like to join in on developing, I recommend checking out the code,
121-
doing `pipenv install` to set up a virtual environment, and then `pipenv shell`
122-
to start using it. You can run the existing tests using `nosetests`. Current
123-
test are not yet comprehensive, as the integrated nature of this makes it difficult.
121+
setting up a virtual environment, and doing `pip install -e .`. You can
122+
run the existing tests using `nosetests`. Current test are not yet
123+
comprehensive, as the integrated nature of this makes it difficult.
124124
But I aim to reduce that problem over time, so please add tests as you go.
125125

126126

@@ -142,12 +142,4 @@ very helpful in figuring out what the Android app was up to,
142142
experiments](https://community.smartthings.com/t/ecovacs-deebot-n79/93410/33)
143143
with his device, and
144144
* All the users who have given useful feedback and reported on how it is
145-
working for them.
146-
147-
148-
149-
150-
151-
## To Do
152-
153-
* add a status commmand
145+
working for them, and even contributed code.

setup.py

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,17 @@
1-
from setuptools import setup, find_packages
21
from codecs import open
32
from os import path
43

5-
from pipenv.project import Project
6-
from pipenv.utils import convert_deps_to_pip
7-
8-
pfile = Project(chdir=False).parsed_pipfile
9-
requirements = convert_deps_to_pip(pfile['packages'], r=False)
10-
test_requirements = convert_deps_to_pip(pfile['dev-packages'], r=False)
11-
4+
from setuptools import setup, find_packages
125

136
here = path.abspath(path.dirname(__file__))
147

158
# Get the long description from the README file
16-
with open(path.join(here, 'README.md'), encoding='utf-8') as f:
9+
with open(path.join(here, 'README.rst'), encoding='utf-8') as f:
1710
long_description = f.read()
1811

1912
setup(
2013
name='sucks',
21-
version='0.8.1',
14+
version='0.8.2',
2215

2316
description='a library for controlling certain robot vacuums',
2417
long_description=long_description,
@@ -60,20 +53,28 @@
6053
# simple. Or you can use find_packages().
6154
packages=find_packages(exclude=['contrib', 'docs', 'tests']),
6255

63-
6456
# List run-time dependencies here. These will be installed by pip when
6557
# your project is installed. For an analysis of "install_requires" vs pip's
6658
# requirements files see:
6759
# https://packaging.python.org/en/latest/requirements.html
6860

69-
install_requires=convert_deps_to_pip(pfile['packages'], r=False),
61+
install_requires=[
62+
'sleekxmpp>=1.3',
63+
'click>=6',
64+
'requests>=2.18',
65+
'pycryptodome>=3.4',
66+
'pycountry-convert>=0.5'
67+
],
7068

7169
# List additional groups of dependencies here (e.g. development
7270
# dependencies). You can install these using the following syntax,
7371
# for example:
7472
# $ pip install -e .[dev,test]
7573
extras_require={
76-
'dev': convert_deps_to_pip(pfile['dev-packages'], r=False),
74+
'dev': [
75+
'nose',
76+
'requests-mock>=1.3'
77+
],
7778
},
7879

7980
# If there are data files included in your packages that need to be

0 commit comments

Comments
 (0)