https://github.com/apache/flagon-distill
Apache Flagon Distill is a python package to support and analyze Flagon UserAle.js logs
https://github.com/apache/flagon-distill
apache behavioral-analytics behavioral-sciences business-analytics flagon jupyter pypi python usability usage user-monitoring
Last synced: 5 months ago
JSON representation
Apache Flagon Distill is a python package to support and analyze Flagon UserAle.js logs
- Host: GitHub
- URL: https://github.com/apache/flagon-distill
- Owner: apache
- License: apache-2.0
- Created: 2016-08-10T07:00:06.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2024-08-20T20:21:42.000Z (over 1 year ago)
- Last Synced: 2024-10-01T01:09:06.859Z (over 1 year ago)
- Topics: apache, behavioral-analytics, behavioral-sciences, business-analytics, flagon, jupyter, pypi, python, usability, usage, user-monitoring
- Language: Python
- Homepage: https://flagon.apache.org/
- Size: 15.8 MB
- Stars: 10
- Watchers: 10
- Forks: 14
- Open Issues: 7
-
Metadata Files:
- Readme: README.rst
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.rst
- License: LICENSE
- Authors: AUTHORS.rst
Awesome Lists containing this project
README
.. ..
Apache Flagon Distill
=====================
🚨 This repository has been archived and it's contents have moved to https://github.com/apache/flagon
-----------------------------------------------------------------------------------------------------
.. image:: https://readthedocs.org/projects/incubator-flagon-distill/badge/?version=distill_toolkit_refactor
:target: https://incubator-flagon-distill.readthedocs.io/en/distill_toolkit_refactor/?badge=stable
:alt: Documentation Status
This project is a work in progress, prior to an official Apache Software Foundation release. Check back soon for important updates.
Please see our `readthedocs.org pages `_ for documentation.
A contribution guide has been provided `here `_.
Installation
------------
To install and set up the Python project, Distill uses `Poetry `_, a dependency and package management tool. Poetry simplifies the management of project dependencies and virtual environments, ensuring consistent and reproducible builds.
Prerequisites
~~~~~~~~~~~~~
Before you begin, make sure you have the following prerequisites installed on your system:
- Python (>= 3.8)
- Poetry (>= 1.0)
You can check your Python version by running:
.. code-block:: bash
python --version
This will return the version of Python installed on your system. If you do not have Python installed, you can download it from the `official website `_. However, we recommend using a Python version manager such as `pyenv`. You can refer to this guide for setting it up: `pyenv guide `_.
You can install Poetry a number of ways (see the `Poetry docs `_ for all methods). We recommend installing one of the following two ways:
**Official Installer**:
*Linux, macOS, Windows (WSL)*
.. code-block:: bash
curl -sSL https://install.python-poetry.org | python3 -
*Windows (Powershell)*
.. code-block:: bash
(Invoke-WebRequest -Uri https://install.python-poetry.org -UseBasicParsing).Content | py -
**pipx**:
.. code-block:: bash
pipx install poetry
The above two methods should minimize the chances of dependency conflicts with your system Python (global) installation. Some users have reported issues with Poetry using an incorrect Python environment instead of the project's local virtual environment when using regular pip method. If you run into issues, please refer to the official Poetry docs or Github for more in-depth installation instructions.
Installation Steps
~~~~~~~~~~~~~~~~~~
Follow these steps to set up and install the project:
1. Clone the repository:
.. code-block:: bash
git clone https://github.com/apache/flagon-distill.git
2. Navigate to the project directory:
.. code-block:: bash
cd flagon-distill
3. Use Poetry to install project dependencies and create a virtual environment:
.. code-block:: bash
poetry install
This command reads the ``pyproject.toml`` file and installs all required packages into a dedicated virtual environment.
4. If you would like to run tests or make changes, install optional dependency groups.
.. code-block:: bash
poetry install --all-groups
5. Run the tests:
You can now run the tests to make sure everything installed properly. For example:
.. code-block:: bash
make test
Remember that you need to activate the virtual environment (step 4) each time you work on the project.
Updating Dependencies
~~~~~~~~~~~~~~~~~~~~~
To update project dependencies, you can use the following command:
.. code-block:: bash
poetry update
This command updates the ``pyproject.toml`` file with the latest compatible versions of the packages.
Uninstalling
~~~~~~~~~~~~
To uninstall the project and its dependencies, simply deactivate the virtual environment (if activated) by typing:
.. code-block:: bash
exit
This will exit the virtual environment. You can then safely delete the project directory.
By following these installation steps, you can easily set up and manage the Python project using Poetry. Enjoy coding!