Skip to content

Commit

Permalink
Improve docs structure
Browse files Browse the repository at this point in the history
  • Loading branch information
NikAzanov committed Nov 8, 2024
1 parent f474fb0 commit 7ec1d35
Show file tree
Hide file tree
Showing 6 changed files with 31 additions and 29 deletions.
6 changes: 3 additions & 3 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -67,14 +67,14 @@ Ready to contribute? Here's how to set up `django-import-export-extensions` for

Using pyenv::

pyenv install 3.12
pyenv shell $(pyenv latest 3.12)
pyenv install 3.13
pyenv shell $(pyenv latest 3.13)
poetry config virtualenvs.in-project true
source .venv/bin/activate && poetry install

Using uv::

uv venv --python 3.12 --prompt django-import-export-extensions --seed
uv venv --python 3.13 --prompt django-import-export-extensions --seed
poetry config virtualenvs.in-project true
source .venv/bin/activate && poetry install

Expand Down
1 change: 1 addition & 0 deletions HISTORY.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ UNRELEASED
* Replaced `sphinx-rtd-theme` by [furo](https://github.com/pradyunsg/furo)
* Update/extend documentation
* Support Python 3.13
* Drop Django <4.2 support

0.7.0 (2024-10-29)
------------------
Expand Down
39 changes: 20 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,22 @@
# Django-import-export-extensions

| Project | | Status |
|-----------|:----|--------|
| Versions | | [![PyPI - Python Versions](https://img.shields.io/pypi/pyversions/django-import-export-extensions)](https://pypi.org/project/django-import-export-extensions/)<br>[![PyPI - Django Versions](https://img.shields.io/pypi/frameworkversions/django/django-import-export-extensions)](https://pypi.org/project/django-import-export-extensions/) |
| CI/CD | | [![Build status on Github](https://github.com/saritasa-nest/django-import-export-extensions/actions/workflows/checks.yml/badge.svg)](https://github.com/saritasa-nest/django-import-export-extensions/actions/workflows/checks.yml)<br>[![Test coverage](https://coveralls.io/repos/github/saritasa-nest/django-import-export-extensions/badge.svg?branch=main)](https://coveralls.io/github/saritasa-nest/django-import-export-extensions?branch=main)<br>[![Documentation Status](https://readthedocs.org/projects/django-import-export-extensions/badge/?version=latest)](https://django-import-export-extensions.readthedocs.io/en/latest/?badge=latest) |
| Statistic | | ![PyPI Downloads](https://static.pepy.tech/badge/django-import-export-extensions/month) |
[![PyPI - Python Versions](https://img.shields.io/pypi/pyversions/django-import-export-extensions)](https://pypi.org/project/django-import-export-extensions/)
[![PyPI - Django Versions](https://img.shields.io/pypi/frameworkversions/django/django-import-export-extensions)](https://pypi.org/project/django-import-export-extensions/)
![PyPI](https://img.shields.io/pypi/v/django-import-export-extensions)

[![Build status on Github](https://github.com/saritasa-nest/django-import-export-extensions/actions/workflows/checks.yml/badge.svg)](https://github.com/saritasa-nest/django-import-export-extensions/actions/workflows/checks.yml)
[![Test coverage](https://coveralls.io/repos/github/saritasa-nest/django-import-export-extensions/badge.svg?branch=main)](https://coveralls.io/github/saritasa-nest/django-import-export-extensions?branch=main)
[![Documentation Status](https://readthedocs.org/projects/django-import-export-extensions/badge/?version=latest)](https://django-import-export-extensions.readthedocs.io/en/latest/?badge=latest)

![PyPI Downloads](https://static.pepy.tech/badge/django-import-export-extensions/month)

## Links

- [Documentation](<https://django-import-export-extensions.readthedocs.io>)
- [GitHub](<https://github.com/saritasa-nest/django-import-export-extensions>)
- [PyPI](<https://pypi.org/project/django-import-export-extensions>)
- [Contibuting](<https://django-import-export-extensions.readthedocs.io/en/stable/contributing.html>)
- [History](https://django-import-export-extensions.readthedocs.io/en/stable/history.html)

## Description

Expand All @@ -15,11 +27,8 @@ adding the following features:
- Import/export resources in the background via Celery
- Manage import/export jobs via Django Admin
- DRF integration that allows to work with import/export jobs via API
- Support
[drf-spectacular](https://github.com/tfranzel/drf-spectacular)
generated API schema
- Additional fields and widgets (FileWidget,
IntermediateManyToManyWidget, IntermediateManyToManyField)
- Support [drf-spectacular](https://github.com/tfranzel/drf-spectacular) generated API schema
- Additional fields and widgets (FileWidget, IntermediateManyToManyWidget, IntermediateManyToManyField)

## Installation

Expand Down Expand Up @@ -101,18 +110,10 @@ class BookImportViewSet(views.ImportJobViewSet):
resource_class = resources.BookResource
```

Don\'t forget to [configure
Don't forget to [configure
Celery](https://docs.celeryq.dev/en/stable/django/first-steps-with-django.html)
if you want to run import/export in background

## Links

- Documentation:
<https://django-import-export-extensions.readthedocs.io>.
- GitHub:
<https://github.com/saritasa-nest/django-import-export-extensions/>
- PyPI: <https://pypi.org/project/django-import-export-extensions/>

## License

- Free software: MIT license
2 changes: 1 addition & 1 deletion docs/getting_started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Getting started
===============

``django-import-export-extensions`` is based on ``django-import-export`` package,
so it follows a similar workflow and interfaces.f you are already familiar with the original package,
so it follows a similar workflow and interfaces. If you are already familiar with the original package,
you can refer to the :ref:`Migrate from original django-import-export package<Migrate from original \`django-import-export\` package>`
section to start using background import/export.

Expand Down
10 changes: 5 additions & 5 deletions docs/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,19 +14,19 @@ Using pip:

.. code-block:: shell
$ pip install django-import-export-extensions
pip install django-import-export-extensions
Using uv:

.. code-block:: shell
$ uv pip install django-import-export-extensions
uv pip install django-import-export-extensions
Using poetry:

.. code-block:: shell
$ poetry add django-import-export-extensions
poetry add django-import-export-extensions
This is the preferred installation method,
as it will always install the most recent stable release of ``django-import-export-extensions``.
Expand All @@ -49,8 +49,8 @@ Finally, run the ``migrate`` and ``collectstatic`` commands:

.. code-block:: shell
$ python manage.py migrate
$ python manage.py collectstatic
python manage.py migrate
python manage.py collectstatic
Celery
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ keywords = [
"django_import_export_extensions",
]
classifiers = [
"Development Status :: 4 - Beta",
"Development Status :: 5 - Production/Stable",
"Intended Audience :: Developers",
"Topic :: Software Development",
"Framework :: Django",
Expand Down

0 comments on commit 7ec1d35

Please sign in to comment.