Skip to content

Commit

Permalink
Merge pull request #5 from octoenergy/explore
Browse files Browse the repository at this point in the history
Minor changes from some light exploration
  • Loading branch information
meshy authored Feb 13, 2024
2 parents df8b9d7 + 806f07d commit f0ad715
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 6 deletions.
4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ build/

# Testing
.pytest_cache/
.tox/

# Environments
.venv/
Expand All @@ -20,3 +21,6 @@ build/

# Environment variables
.env

# Pyenv
.python-version
15 changes: 9 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Django Integrity

Django Integrity contains tools for controlling deferred constraints
and handling IntegrityErrors in Django projects which use PostgreSQL.
and handling `IntegrityError`s in Django projects which use PostgreSQL.

## Supported dependencies

Expand All @@ -14,14 +14,12 @@ This package is tested against:

### Creating a virtual environment

Ensure Python is installed and used by the `python` executable:
Ensure one of the above Pythons is installed and used by the `python` executable:

```sh
python --version
```

Be sure to check that the Python version you are using is in the supported versions listed above.

Then create and activate a virtual environment. If you don't have any other way of managing virtual
environments this can be done by running:

Expand All @@ -33,10 +31,15 @@ source .venv/bin/activate
You could also use [virtualenvwrapper], [direnv] or any similar tool to help manage your virtual
environments.

### Install PostgreSQL

Ensure that PostgreSQL with minimum version 12 is installed and running on your local machine.

### Installing Python dependencies

Note: You might not need to install the below requirements if you only intend to run the tests,
because we use [tox] for the tests, and it manages the installation of dependencies.
> [!NOTE]
> You might not need to install the below requirements if you only intend to run the tests,
> because we use [tox] for the tests, and it manages the installation of dependencies.
If you only intend to run the tests with [tox], then you may only require:

Expand Down

0 comments on commit f0ad715

Please sign in to comment.