Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Preparation for stable release #64

Merged
merged 3 commits into from
Nov 8, 2024
Merged

Preparation for stable release #64

merged 3 commits into from
Nov 8, 2024

Conversation

NikAzanov
Copy link
Contributor

  • Improve grammar and structure of documentation
  • Extend docs it with examples
  • Convert README.rst to markdown format
  • Update Django & Python versions
  • Update CONTRIBUTING.rst

Improve grammar and structure of documentation
Extend it with examples
@coveralls
Copy link

coveralls commented Nov 8, 2024

Pull Request Test Coverage Report for Build 11739652549

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 100.0%

Totals Coverage Status
Change from base Build 11677939803: 0.0%
Covered Lines: 1429
Relevant Lines: 1429

💛 - Coveralls

CONTRIBUTING.rst Outdated Show resolved Hide resolved
CONTRIBUTING.rst Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Outdated
Comment on lines 3 to 7
| 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) |

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In invocations it looks more readable, also let's add extra one(from saritasa invocations)

GitHub Workflow Status (with event)
PyPI
PyPI - Status
PyPI - Python Version
PyPI - Django Version
PyPI - License
PyPI - Downloads
Ruff

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code - yes
Format - I believe that table is more convenient

image

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's just usually all others do one liner
image
image
image

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Personally I don't like one liners with lots of items

I suggest making it this way:

image

Simple in code, looks better in UI

pyproject.toml Outdated Show resolved Hide resolved
Comment on lines +35 to +41
"Programming Language :: Python",
"Programming Language :: Python :: 3",
"Programming Language :: Python :: 3.10",
"Programming Language :: Python :: 3.11",
"Programming Language :: Python :: 3.12",
"Programming Language :: Python :: 3.13",
"Programming Language :: Python :: 3 :: Only",

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No need for this, poetry sets it automatically, just when publishing make sure you are on python 3.13

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What versions will be set by poetry?

I didn't find anything about it in poetry docs. So I'm not sure if we should make it implicit.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

From min allowed to the one you use as far as I understand
You can unzip file located in dist with .whl extension then
image
image

pyproject.toml Show resolved Hide resolved
pyproject.toml Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
docs/getting_started.rst Outdated Show resolved Hide resolved
docs/installation.rst Outdated Show resolved Hide resolved
@NikAzanov NikAzanov merged commit f0d8e64 into main Nov 8, 2024
18 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants