Skip to content

Latest commit

 

History

History
141 lines (85 loc) · 4.09 KB

README.rst

File metadata and controls

141 lines (85 loc) · 4.09 KB

alfa-agent

Table of Contents

Installation

alfa-agent is distributed on PyPI as a universal wheel and is available on Linux/macOS and Windows and supports Python 3.5+ and PyPy.

$ sudo pip3 install alfa-agent
$ sudo python3 -m alfa_agent _start

It can also be installed from binary file (*.whl) by typing the following:

$ sudo pip3 install alfa_agent-<VERSION_NUMBER>.whl
$ sudo python3 -m alfa_agent _start

See Packaging & Distribution section in order to generate binary files.

Development Environment

Make sure you have at least Python 3.5.x installed, cd into project directory then type the following commands:

$ pip3 install --upgrade virtualenv hatch
$ hatch env alfa && hatch shell alfa
$ pip3 install -r requirements.txt

That's it.

Now you can start development, or run the project by typing:

$ hatch shell alfa # if you have NOT already activated alfa virtual environment.
$ export PYTHONPATH=$PYTHONPATH:$HOME/git/alfa-agent # so that Python can find the package
$ python3 $HOME/git/alfa-agent/alfa_agent/cli.py _start

We should provide the full path here so that the elevated process can work properly.

NOTE:

Normally, when the agent starts up it tries to collect system info and send it to the Alfa Server. In order to do so, it needs to run with elevated privileges if it is not already. This is done automatically after checking send_sysinfo_on_startup property in agent.ini file.

If you are running the agent inside PyCharm, the debugger loses the newly (elevated) process hence it fails. So if you are using PyCharm, make sure to set send_sysinfo_on_startup=False.

Packaging & Distribution

Type the following:

$ hatch shell alfa # if you have NOT already activated alfa virtual environment.
$ hatch build

This will produce one source file (.tar.gz) and one binary file (.whl) under dist/ directory.

You can also use hatch clean to remove any build artifacts (e.g. *.pyc, __pycache__, *.egg-info)

Versioning

We use hatch for versioning as well, here are a few examples:

$ hatch grow build
Updated /home/emre/git/alfa-agent/alfa_agent/__init__.py
0.0.1 -> 0.0.1+build.1
$ hatch grow fix
Updated /home/emre/git/alfa-agent/alfa_agent/__init__.py
0.0.1+build.1 -> 0.0.2
$ hatch grow minor
Updated /home/emre/git/alfa-agent/alfa_agent/__init__.py
0.0.2 -> 0.1.0
$ hatch grow major
Updated /home/emre/git/alfa-agent/alfa_agent/__init__.py
0.1.0 -> 1.0.0

Logging

Logging can be configured either in the default config file data/conf/logging.yaml or by providing a specific path to another config file in the environment variable named LOG_CFG such as this:

$ LOG_CFG=my_logging.yaml python3 $HOME/git/alfa-agent/alfa_agent/cli.py _start

Default config file data/conf/logging.yaml consists of Console logger with DEBUG level, and two rotating file loggers for INFO and ERROR separately.

If no config file is provided or the agent cannot find/read the provided file, basic configuration with INFO level will be used as backup.

Requirement Management

Requirements needed to setup development environment are declared in requirements.txt file which can be installed via pip3 install -r requirements.txt.

Requirements for the installation, on the other hand, are declared in setup.py (REQUIRES array) for Python modules and in config.yaml (platform_requires section) file for the platform-specific dependencies.

Python modules are automatically handled during agent installation but platform-specific dependencies must be installed manually by typing python -m alfa_agent install with sudo (or Admin for Windows) privileges.

License

alfa-agent is distributed under the terms of the MIT License.