Skip to content

Commit

Permalink
getting started on getting started
Browse files Browse the repository at this point in the history
  • Loading branch information
tataraba authored and adamghill committed Jul 26, 2024
1 parent 87a3682 commit 55a8812
Show file tree
Hide file tree
Showing 3 changed files with 36 additions and 3 deletions.
29 changes: 29 additions & 0 deletions docs/source/getting-started.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# Getting Started

## Create a Django Project

Django `Unicorn` does not come bundled with `Django`, which means you will first need to have a working
Django project in order to take advantage of `Unicorn`. While it is recommended that you have some experience
working with Python and Django, below is a list of steps you would need to take in order to begin working with
Django `Unicorn`.

```{dropdown} Install the latest version of Python
Django `Unicorn will work with Python 3.8 or greater. But if you don't have Python installed, you will need to
download and install Python to your local machine.
You can find the [latest version](https://www.python.org/downloads/) of Python at [Python.org](https://www.python.org).
Once you have installed Python, make sure that it has been added to your PATH. You can check if it is in your path by opening
up a Terminal and checking for your version of Python.
`python --version`
```

```{dropdown} Create a virtual environment
does this work?
```{shell}
python -m venv .venv
```
```
1 change: 1 addition & 0 deletions docs/source/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
:hidden:
self
getting-started
installation
components
```
Expand Down
9 changes: 6 additions & 3 deletions docs/source/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,18 @@

Install `Unicorn` the same as any other Python package (preferably into a [virtual environment](https://docs.python.org/3/tutorial/venv.html)).

````{tab-set}
```{tab-item} pip
```shell
pip install django-unicorn
```
```
OR

```shell
```{tab-item} poetry
poetry add django-unicorn
```
````


```{note}
If attempting to install `django-unicorn` and `orjson` is preventing the installation from succeeding, check whether it is using 32-bit Python. Unfortunately, `orjson` is only supported on 64-bit Python. More details in [issue #105](https://github.com/adamghill/django-unicorn/issues/105).
Expand Down

0 comments on commit 55a8812

Please sign in to comment.