Developer Guide
You need a copy of this repository placed in a folder on your pi, e.g., /pi/home/callattendant. You can use a different folder if you want (I prefer /home/pi/src/callattendant). These instructions use the home folder just to keep them simple.
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.
Using HTTPS
cd
git clone https://github.com/emxsys/callattendant.git
cd callattendantUsing SSH (see GitHub: About SSH)
cd
git clone git@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.
The following instructions create and activate a virtual environment named venv within the current folder:
# Install virtualenv - if not installed
sudo apt install virtualenv
# Create the virtual environment
virtualenv venv --python=python3
# Activate it
source venv/bin/activateNow you're operating with a virtual Python. To check, issue the which command and ensure the output points to your virtual environment; and also check the Python version:
which python
# /home/pi/venv/bin/python
python --version
# Python 3.7.3We'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.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.
There's a __main__.py file in the top-level package, so you can start the program using the package name. In the project directory, issue the following command:
python callattendant --help
# Usage: callattendant --config [FILE] --data-path [FOLDER]
# Options:
# -c, --config [FILE] load a python configuration file
# -d, --data-path [FOLDER] path to data and configuration files
# -f, --create-folder create the data-path folder if it does not exist
# -h, --help displays this help textRunning the software for the first time requires the creation of a data folder using the --create-folder option. The default location is ~/.callattendant. You can override this location using the --data-path option.
python callattendant --create-folderYou should see output of the form:
Command line options:
--config=None
--data-path=None
--create-folder=True
[Configuration]
BLOCKED_ACTIONS = ('greeting', 'record_message')
BLOCKED_GREETING_FILE = /home/pi/src/callattendant/callattendant/resources/blocked_greeting.wav
BLOCKED_RINGS_BEFORE_ANSWER = 0
BLOCK_ENABLED = True
BLOCK_NAME_PATTERNS = {'V[0-9]{15}': 'Telemarketer Caller ID'}
BLOCK_NUMBER_PATTERNS = {}
DATABASE = callattendant.db
DATA_PATH = /home/pi/.callattendant
DB_FILE = /home/pi/.callattendant/callattendant.db
DEBUG = False
ENV = production
PERMITTED_ACTIONS = ()
PERMITTED_GREETING_FILE = /home/pi/src/callattendant/callattendant/resources/general_greeting.wav
PERMITTED_RINGS_BEFORE_ANSWER = 4
ROOT_PATH = /home/pi/src/callattendant/callattendant
SCREENED_ACTIONS = ()
SCREENED_GREETING_FILE = /home/pi/src/callattendant/callattendant/resources/general_greeting.wav
SCREENED_RINGS_BEFORE_ANSWER = 0
SCREENING_MODE = ('whitelist', 'blacklist')
TESTING = False
VOICE_MAIL_GOODBYE_FILE = /home/pi/src/callattendant/callattendant/resources/goodbye.wav
VOICE_MAIL_GREETING_FILE = /home/pi/src/callattendant/callattendant/resources/general_greeting.wav
VOICE_MAIL_INVALID_RESPONSE_FILE = /home/pi/src/callattendant/callattendant/resources/invalid_response.wav
VOICE_MAIL_LEAVE_MESSAGE_FILE = /home/pi/src/callattendant/callattendant/resources/please_leave_message.wav
VOICE_MAIL_MENU_FILE = /home/pi/src/callattendant/callattendant/resources/voice_mail_menu.wav
VOICE_MAIL_MESSAGE_FOLDER = /home/pi/.callattendant/messages
{MSG LED OFF}
Starting the Flask webapp
Running Flask webapp
* 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
Navigate to <pi_address> on port 5000 and you should see the Call Attendant web interface home page. Make a few calls to yourself to test the service.
pytest is used for unit testing.
# Run from the top-level package in your project (your path may be different)
cd ~/callattendant/callattendant
# Runnning "python -m pytest ..." adds the current directory to the sys.path
python -m pytest ../testsExcerpts from https://packaging.python.org/tutorials/packaging-projects/
# Make sure you have the latest versions of setuptools and wheel installed:
python -m pip install --user --upgrade setuptools wheel
# Now run this command from the same directory where setup.py is located:
python 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:
python -m pip install --user --upgrade twine
# Once intalled, run Twine to upload all of the archives under dist:
python -m twine upload --repository testpypi dist/*You can use pip to install your package and verify that it works. Create a new virtualenv (see Installing Packages for detailed instructions) and install your package from TestPyPI:
python -m pip install --index-url https://test.pypi.org/simple/ --no-deps example-pkg-YOUR-USERNAME-HEREThis document provides a comprehensive architectural overview of the system, using a number of different architectural views to depict different aspects of the system. It is intended to capture and convey the significant architectural decisions which have been made on the system.
This section describes what software architecture is for the current system, and how it is represented. Of the Use-Case, Logical, Process, Deployment, and Implementation Views, it enumerates the views that are necessary, and for each view, explains what types of model elements it contains.
This section contains use cases or scenarios from the use-case model if they represent some significant, central functionality of the final system, or if they have a large architectural coverage—they exercise many architectural elements or if they stress or illustrate a specific, delicate point of the architecture.
This section describes the architecturally significant parts of the design model, such as its decomposition into subsystems and packages. And for each significant package, its decomposition into classes and class utilities. You should introduce architecturally significant classes and describe their responsibilities, as well as a few very important relationships, operations, and attributes.
This section describes the system's decomposition into lightweight processes (single threads of control) and heavyweight processes (groupings of lightweight processes). Organize the section by groups of processes that communicate or interact. Describe the main modes of communication between processes, such as message passing, interrupts, and rendezvous.
This section describes the overall structure of the implementation model, the decomposition of the software into layers and subsystems in the implementation model, and any architecturally significant components.
This section describes one or more physical network (hardware) configurations on which the software is deployed and run. It is a view of the Deployment Model. At a minimum for each configuration it should indicate the physical nodes (computers, CPUs) that execute the software and their interconnections (bus, LAN, point-to-point, and so on.) Also include a mapping of the processes of the Process View onto the physical nodes.
This section contains a description of the persistent data storage perspective of the system. This section is optional if there is little or no persistent data, or the translation between the Design Model and the Data Model is trivial.
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 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!