Developer Guide
The development plan's phase objectives are captured in the GitHub projects.
- Iteration #I1: v0.1
- Iteration #E1: v0.2
- Iteration #T1: v1.0
You need a copy of this repository placed in a folder on your pi, e.g., /pi/home/callattendant.
You can either clone this repository, or download a zip file,
or download a specific release from Releases.
Here's how clone the repository with git into your home folder:
cd
git clone https://github.com/emxsys/callattendant.git
cd callattendantIf you download the latest code or a
specific release, the unzpped folder will be named callattendant-master or callattendant-<release_tag>
depending on what you downloaded. You can rename it if you wish. Here's how unzip it into your home folder.
cd
unzip ~/Downloads/callattendant-master.zip
cd callattendant-masterThe installation calls for Python3.x.
Note, if you are going to use a virtual environment, you will use the python command.
Whereas, if you use the Python release provided by the Raspberry Pi you will be using
the python3 command. If you use the python command outside the virtual environment
you will be running Python2.x
For development purposes, you might be best served by setting up a virtual environment. If you intend to simply install and run the callattendant on a dedicated Raspberry Pi, you can skip this step and proceed with Install Packages.
The following instructions create a virtual environment named python3 within the current folder:
sudo apt install virtualenv
virtualenv python3 --python=python3
source python3/bin/activateNow you're operating with a virtual Python. To check, issue the following command:
$ which pythonYou should see output of the form:
(python3) pi@raspberryi:~/testing $ which python
/home/pi/testing/python3/bin/python
To make sure you're on 3.x as requested, issue:
$ python --versionYou should see output of the form:
(python3) pi@raspberrypi:~/testing $ python --version
Python 3.7.3
We've provided a requirements file called requirements.txt. Let's use it to
install the required packages. But first, navigate to the folder where the
callattendant repository was placed, e.g., /pi/home/callattendant.
For the virtual environment:
$ pip install -r requirements.txtor for the preinstalled Python version:
$ pip3 install -r requirements.txtIf you intend to run the callattendant as a service, you'll need to install the dependencies as the root user. E.g.,
$ sudo pip3 install -r requirements.txtIn my install, lxml took a long time to build (because Raspberry Pi) but it's worth the wait to get to that part of blocking spam calls. So chill and do whatever it is you do while software builds.
In the callattendant/src directory, issue the following command:
python callattendant.pyYou should see output of the form:
(python3) pi@raspberrypi:~/testing/callattendant/src $ python callattendant.py
CallLogger initialized
Blacklist initialized
Whitelist initialized
Modem COM Port is: /dev/ttyACM0
* Serving Flask app "userinterface.webapp" (lazy loading)
* Environment: production
WARNING: This is a development server. Do not use it in a production deployment.
Use a production WSGI server instead.
* Debug mode: off
* Running on http://0.0.0.0:5000/ (Press CTRL+C to quit)
Navigate to <pi_address> on port 5000 and you should see the home page. Make a few calls to yourself to test the service.
twine requires Python 3.6 or greater. Here's how I upgraded from 3.5.3 to 3.8.5:
# Install prerequisites
sudo apt-get install -y build-essential tk-dev libncurses5-dev libncursesw5-dev libreadline6-dev libdb5.3-dev libgdbm-dev libsqlite3-dev libssl-dev libbz2-dev libexpat1-dev liblzma-dev zlib1g-dev libffi-dev tar wget vim
# Download Python
cd ~/Downloads/
wget https://www.python.org/ftp/python/3.8.5/Python-3.8.5.tgz
# Install Python (this takes awhile)
sudo tar zxf Python-3.8.5.tgz
cd Python-3.8.5
sudo ./configure --enable-optimizations
sudo make -j 4
sudo make altinstallpytest is used for unit testing.
# Install
pip3 install pytest# Run from the top-level package
cd ~/callattendant/callattendant
# Runnning "python -m pytest ..." adds the current directory to the sys.path
python -m pytest ../tests# Make sure you have the latest versions of setuptools and wheel installed:
python3 -m pip install --user --upgrade setuptools wheel
# Now run this command from the same directory where setup.py is located:
python3 setup.py sdist bdist_wheelGo to https://test.pypi.org/manage/account/#api-tokens and create a new API token;
# You can use twine to upload the distribution packages. You’ll need to install Twine:
python3 -m pip install --user --upgrade twine
# Once intalled, run Twine to upload all of the archives under dist:
python3 -m twine upload --repository testpypi dist/*You can use the SQLiteBrowser to examine and/or modify the callattendant database.
sudo apt-get install sqlitebrowser
sqlitebrowser callattendant.dbThe following blogs from IoT Bytes by Pradeep Singh were very useful for learning to how to program the Raspberry Pi and the US Robotics 5637 modem. His blog site has many Raspberry Pi resources. Thanks Pradeep!