diff options
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 29 |
1 files changed, 20 insertions, 9 deletions
@@ -1,11 +1,22 @@ -# infra -Infrastructure for Python Discord +# Infra -# Local dev setup -1. Create a virtual environment `python -m venv venv` +This repository contains the infrastructure configuration for Python Discord, the file structure is as follows: + +```yaml +playbook.yml # Root playbook pulling all roles together +inventory.yaml # Ansible Inventory file +ansible.cfg # Ansible Configurartion file +roles/ # Directory containing all Ansible roles +.github/ + workflows/ # GitHub Actions Workflows for CI +requirements.txt # Python requirements +``` + +## Local Environment Setup +1. Create a virtual environment: `python -m venv venv` 1. Activate the virtual environment - - Windows `.\venv\Scripts\activate` - - Linux `source venv/bin/activate` -1. Update pip and builder deps `python -m pip install --upgrade pip wheel setuptools` -1. Install project dependancies `python -m pip install -r requirements.txt` -1. Install the pre-commit hook `pre-commit install` + - Windows: `.\venv\Scripts\activate` + - Linux: `source venv/bin/activate` +1. Update pip and builder deps: `python -m pip install --upgrade pip wheel setuptools` +1. Install project dependancies: `python -m pip install -r requirements.txt` +1. Install the pre-commit hook: `pre-commit install` |