Skip to content

📥 Instructions

Follow these steps to clone the repository, set up the environment, and run the ATHENA dashboard.

Prerequisites:

  • 🐍 Python 3.10+

Ensure you have Python 3.10+ installed. If not, download and install it from the official Python website. Check your version:

python --version
For installation guides and troubleshooting, refer to the RealPython documentation.

Tip

If you don't have prior experience with Python, we recommend reading Using Python's pip to Manage Your Projects' Dependencies, which is a really good introduction on the mechanics of Python package management and helps you troubleshoot if you run into errors.

🐙 Git

Step 1. Open your terminal or command prompt.

Step 2. Clone the ATHENA repository from GitHub:

git clone https://github.com/your-repo/athena-recruitment-analytics.git

Step 3. Navigate to the project directory:

cd athena-recruitment-analytics

📦 Package manager

Step 4. Create a virtual environment to isolate dependencies:

python -m venv .venv

Step 5. Activate the virtual environment:

.venv\Scripts\activate

source .venv/bin/activate

Step 6. Upgrade pip to the latest version:

pip install --upgrade pip

Install Dependencies

Step 7. Install the required Python packages using requirements.txt:

pip install -r requirements.txt

Step 4. Make sure Poetry is installed:

curl -sSL https://install.python-poetry.org | python3 -
export PATH="$HOME/.local/bin:$PATH"

Step 5. Configure a virtual environment to isolate dependencies:

poetry install

Step 6. Activate the virtual environment:

poetry shell

Update Dependencies

Step 7. Add, remove, or update packages:

poetry add pandas
poetry remove pandas
poetry update

Step 8. Run the ATHENA Dashboard

Start the dashboard application:

python app.py

Open your web browser and navigate to:

http://127.0.0.1:8050/