This is the official GitHub organization for Echoenergia's Performance team. Here, we centralize the key Python packages and tools developed and used by our team.
We encourage all team members to contribute! If you've written code that could be reused, this is the place for it. Please ensure your code is well-documented to help your colleagues. For great tips on documentation, see these Python documenting guidelines.
Before you start, please check out our central Documentation repository for useful information and standards.
To use our packages, you first need to set up your local environment correctly.
-
Python 🐍: Our standard environment is Python 3.12. Ensure you have it installed.
conda install python=3.12
-
GitHub CLI: The installation command requires you to be authenticated via the GitHub CLI.
- Install it: If you don't have it, run
winget install --id GitHub.clion Windows or follow the official installation guide for macOS/Linux. - Authenticate: After installation, run
gh auth loginand follow the prompts.
- Install it: If you don't have it, run
-
uv Package Installer: We use
uvfor significantly faster package installation than standardpip.# Install uv using pip pip install uv
Once the prerequisites are met, you can install all standard team packages with this single command. It securely downloads the package list and installs them using uv.
curl -sL -H "Authorization: token $(gh auth token)" -H "Accept: application/vnd.github.v3.raw" "https://api.github.com/repos/performance-echo/.github/contents/echo_packages.txt?ref=main" | uv pip install -r -Note
If you want to update all the dependent pacakges, please add -U right after uv pip install in the command above.