aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorGravatar Chris Lovering <[email protected]>2022-01-10 18:04:57 +0000
committerGravatar Chris Lovering <[email protected]>2022-01-10 19:40:56 +0000
commit95f97ac5576da718893aa463aafe27b46cc3ebff (patch)
tree9d70e30a3493e46469b9310428fbb42120f8f55a
parentMerge pull request #4 from python-discord/status-embed-flow (diff)
Setup project deps for ansible-lint and update README
-rw-r--r--.gitignore1
-rw-r--r--README.md9
-rw-r--r--requirements.txt3
3 files changed, 13 insertions, 0 deletions
diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..5ceb386
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1 @@
+venv
diff --git a/README.md b/README.md
index 7d945d2..6233eb9 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,11 @@
# infra
Infrastructure for Python Discord
+
+# Local dev 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`
diff --git a/requirements.txt b/requirements.txt
new file mode 100644
index 0000000..4112fa7
--- /dev/null
+++ b/requirements.txt
@@ -0,0 +1,3 @@
+ansible
+ansible-lint[yamllint]
+pre-commit