Skip to content

Commit

Permalink
Updates to Installation Guide - Common Issues Getting Started (#405)
Browse files Browse the repository at this point in the history
* Update README.md add python3 instead of python

* Create problem-solving.md

* Update installation.md including link to problem-solving

* Add general debugging doc

* Update installation.md
  • Loading branch information
aimeewirick authored Jun 9, 2024
1 parent a9de56c commit 0b0458c
Show file tree
Hide file tree
Showing 4 changed files with 47 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,8 +88,8 @@ To contribute code:
3. Create a new branch for your changes.
4. Make your changes, following the coding style guidelines.
5. Test your changes thoroughly
- `python manage.py test`
- run the app (`python manage.py runserver`)
- `python3 manage.py test`
- run the app (`python3 manage.py runserver`)
- view any changed pages in browser (`http://127.0.0.1:8000`) and make sure the changes work as expected
6. Submit a pull request to the main repository's `main` branch.

Expand Down Expand Up @@ -486,8 +486,8 @@ manually edit with the details below.

### How to edit the contributors table?

- Updated any info using `python manage.py contriubtors`
- Run `python manage.py contributors sync`
- Updated any info using `python3 manage.py contriubtors`
- Run `python3 manage.py contributors sync`
- Make a PR to request these changes in
- Done :)

Expand Down
28 changes: 28 additions & 0 deletions docs/debugging/problem-solving.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
## **Common error messages and their solutions:**

1. If you receive this error: **ImportError: cannot import name 'login_not_required' from 'login_required** <br /> You may be missing some django middleware.

To fix this:
```shell
pip install django-login-required-middleware
```

2. If you receive this error: **No module named 'forex_python'**

Do this:
```shell
pip install forex_python
```

3. To fix several **boto3** "extension name here" **not found errors**

Do the following:
```shell
pip install mypy_boto3_iam

pip install mypy_boto3_scheduler

pip install mypy_boto3_events

pip install mypy_boto3_stepfunctions
```
4 changes: 4 additions & 0 deletions docs/debugging/python/poetry.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,3 +19,7 @@ poetry install
```

And this time they should all be correctly installed!

# For other poetry issues, or if this doesn't fix the issue try the following:
- Delete all files in your directory associate with poetry.
- Follow these directions to use the installer on [poetry's website]( https://python-poetry.org/docs/#installing-with-the-official-installer).
11 changes: 11 additions & 0 deletions docs/getting-started/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,13 +42,21 @@ git clone [copied fork url]
./venv/Scripts/activate
```
OR if you are running in a POSIX system such as: bash/zsh, fish, csh/tcsh, or PowerShell, the command to activate the virtual environment is:

```shell
./venv/bin/activate
```
More information [here](https://docs.python.org/3/library/venv.html)

2. Install our dependencies using [python poetry](https://python-poetry.org/docs/#installing-manually)
```shell
pip install poetry
poetry install --no-root --with mypy,django,dev
```
If the installation of poetry gives error messages check out our [debugging section on poetry](../debugging/python/poetry.md).

3. Setup a database (we suggest using sqlite so there's no installation!)
To do this you can use one of our database guides, we currently only support 3 databases:
- [SQlite3 (recommended for dev)](./databases/sqlite.md)
Expand Down Expand Up @@ -115,3 +123,6 @@ npm run webpack-dev # this only runs it once
npm run webpack-watch # this does the same as above, but listens for updates
```
### Problem Solving Errors
If you are having trouble with the installation process, we have some possible fixes. Check out our [debugging](../debugging/) section.

0 comments on commit 0b0458c

Please sign in to comment.