Skip to content

Commit

Permalink
237: poetry install warning
Browse files Browse the repository at this point in the history
- updated documentation to use "--no-root" option
- do not install root project for djlint CI step
  • Loading branch information
introkun committed Mar 31, 2024
1 parent 0358e1d commit 1757c1b
Show file tree
Hide file tree
Showing 5 changed files with 9 additions and 14 deletions.
7 changes: 1 addition & 6 deletions .github/workflows/run_djlint.yml
Original file line number Diff line number Diff line change
Expand Up @@ -49,14 +49,9 @@ jobs:
if: steps.cached-poetry-dependencies.outputs.cache-hit != 'true'
run: poetry install --only dev --no-interaction --no-root
#----------------------------------------------
# install your root project, if required
#----------------------------------------------
- name: Install library
run: poetry install --no-interaction
#----------------------------------------------
# add matrix specifics and run lints
#----------------------------------------------
- name: Run Lint
run: |
source .venv/bin/activate
poetry run djlint ./frontend/templates/ --check --profile=django
poetry run djlint ./frontend/templates/ --check --profile=django
4 changes: 2 additions & 2 deletions docs/getting-setup/other-environments/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

[Install Poetry](https://python-poetry.org/docs/#installing-manually)
```bash
poetry install
poetry install --no-root
```

4. [Setup our frontend (click to view guide)](getting-setup/other-environments/frontend)
Expand All @@ -20,4 +20,4 @@ npm run tailwind-build

```bash
python manage.py runserver
```
```
4 changes: 2 additions & 2 deletions docs/getting-setup/other-environments/django.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
using `python poetry` [click here for installation guide](https://python-poetry.org/docs/#installing-manually)

```bash
poetry install
poetry install --no-root
```

2. Setup your database [(click to view our guide)](getting-setup/databases/)
Expand All @@ -27,4 +27,4 @@ python manage.py createsuperuser

```bash
python manage.py runserver
```
```
4 changes: 2 additions & 2 deletions docs/getting-setup/pycharm/django.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ and run server. For more details, view the page for your environment below

<br>

!> Before continuing, please install all of our dependencies via `poetry install`"
!> Before continuing, please install all of our dependencies via `poetry install --no-root`"

9. To refresh the cache, go back to settings, project, and interpreter and install "Django" if not already there

Expand All @@ -70,4 +70,4 @@ and run server. For more details, view the page for your environment below
<img src="_assets/setup/pycharm-8-2.png" />
</details>

12. Setup your database [(click to view our guide)](getting-setup/databases/)
12. Setup your database [(click to view our guide)](getting-setup/databases/)
4 changes: 2 additions & 2 deletions docs/how-to-contribute.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ completely fine! Just make sure that you put in your PR that tests are still req
```bash
### first time setup
pip install poetry # installs poetry
poetry install --with dev # installs djlint and black
poetry install --no-root --with dev # installs djlint and black
### tests
python manage.py test --parallel # runs our django tests
djlint ./frontend/templates --reformat # runs our djLint formatter for HTML
Expand All @@ -68,4 +68,4 @@ That's about it! If you struggle at any parts, and just need a bit of support yo
our [discord server](https://discord.gg/YDQq2uc2ap) or
create a PR and mention that you need help.

Good luck! Have fun, don't stress if you need to take a break or need help, just speak to us!
Good luck! Have fun, don't stress if you need to take a break or need help, just speak to us!

0 comments on commit 1757c1b

Please sign in to comment.