Skip to content

docs: add environment checklist for first run #68

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mehmetyavuzz43 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: add environment checklist for first run #68

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions docs/env-checklist.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Environment Checklist

Before running the examples:

- Python version matches the repo requirement
- Virtualenv is activated
- `pip install -r requirements.txt` completed successfully
- Credentials/config file exists and is gitignored
- No secrets appear in your `git diff`

If something fails:
- re-create the venv
- re-install requirements
- verify file paths used by scripts