Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/chris48s/wagtail-release-test-20231012
https://github.com/chris48s/wagtail-release-test-20231012
Last synced: 24 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/chris48s/wagtail-release-test-20231012
- Owner: chris48s
- License: mit
- Created: 2023-10-12T19:32:31.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2023-10-13T07:39:19.000Z (about 1 year ago)
- Last Synced: 2023-10-14T17:26:29.420Z (about 1 year ago)
- Language: Python
- Size: 15.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
# Wagtail Release Test 20231012
A one line description of your package.
[](https://opensource.org/licenses/MIT)
[](https://badge.fury.io/py/wagtail-release-test-20231012)
[](https://github.com/chris48s/wagtail-release-test-20231012/actions/workflows/test.yml)
## Links
- [Documentation](https://github.com/chris48s/wagtail-release-test-20231012/blob/main/README.md)
- [Changelog](https://github.com/chris48s/wagtail-release-test-20231012/blob/main/CHANGELOG.md)
- [Contributing](https://github.com/chris48s/wagtail-release-test-20231012/blob/main/CONTRIBUTING.md)
- [Discussions](https://github.com/chris48s/wagtail-release-test-20231012/discussions)
- [Security](https://github.com/chris48s/wagtail-release-test-20231012/security)
## Supported versions
- Python ...
- Django ...
- Wagtail ...
## Installation
- `python -m pip install wagtail-release-test-20231012`
- ...
## Contributing
### Install
To make changes to this project, first clone this repository:
```sh
git clone https://github.com/chris48s/wagtail-release-test-20231012.git
cd wagtail-release-test-20231012
```
With your preferred virtualenv activated, install testing dependencies:
#### Using pip
```sh
python -m pip install --upgrade pip>=21.3
python -m pip install -e .[testing] -U
```
#### Using flit
```sh
python -m pip install flit
flit install
```
### pre-commit
Note that this project uses [pre-commit](https://github.com/pre-commit/pre-commit).
It is included in the project testing requirements. To set up locally:
```shell
# go to the project directory
$ cd wagtail-release-test-20231012
# initialize pre-commit
$ pre-commit install
# Optional, run all checks once for this, then the checks will run only on the changed files
$ git ls-files --others --cached --exclude-standard | xargs pre-commit run --files
```
### How to run tests
Now you can run tests as shown below:
```sh
tox
```
or, you can run them for a specific environment `tox -e python3.11-django4.2-wagtail5.1` or specific test
`tox -e python3.11-django4.2-wagtail5.1-sqlite wagtail-release-test-20231012.tests.test_file.TestClass.test_method`
To run the test app interactively, use `tox -e interactive`, visit `http://127.0.0.1:8020/admin/` and log in with `admin`/`changeme`.