Skip to content

Commit

Permalink
Prepare 0.1.1 release
Browse files Browse the repository at this point in the history
  • Loading branch information
bogdanpetrea committed Feb 12, 2024
1 parent 95aed34 commit c83bb97
Show file tree
Hide file tree
Showing 5 changed files with 35 additions and 17 deletions.
4 changes: 4 additions & 0 deletions CHANGELOG.MD
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,10 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [0.1.1] - 2024-02-12
### Changes
- Changed the `object_id` field used for GenericForeignKey in AssignedPerm from TextField to CharField(max_length=40) to fix a MySQL indexing error. Technically this is a breaking change, but this project hasn't been announced yet anyway...
- Bump some deps.

## [0.1.0] - 2024-02-09
- Initial release.
12 changes: 10 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,18 @@
# django-woah
A package intended to aid developers in implementing authorization for their Django apps.
A package intended to aid developers in implementing authorization for Django apps.


## Installation
`pip install django-woah`

Then, in your `settings.py`, add it to the `INSTALLED_APPS`:
```python
INSTALLED_APPS = [
# [...]
"django_woah",
]
```


## What it can do

Expand Down Expand Up @@ -179,7 +187,7 @@ To see more code in action you can check the [examples](https://github.com/press

## Current status and future plans

- Although the library hasn't reached version 1.0 yet, it is being used in production at Presslabs, with most, if not all of it's functionality tested.
- Although the library hasn't reached version 1.0 yet, it is soon going to be used in production at Presslabs, with most, if not all of it's functionality tested.
- This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). That means until version 1.0, breaking changes are to be expected from one version to another, although they will be documented in the [changelog](CHANGELOG.MD).
- There is a good chance for pre-1.0 versions to be maintained for a while, in terms of compatibility with newer Django and Python versions, as well as critical bugfixes. You might have to provide a pull request yourself though, but we'll, at the least, review it and hopefully ship it in a maintenance release.
- The abstractions around how Conditions are composed and relate to AuthorizationSchemes/Solver could've been more inspired (see [Shortcomings](#shortcomings)). Therefore, a major rework could happen before the 1.0 release, but chances are it will take a while longer to materialize, as the current API is *usable* enough.
Expand Down
4 changes: 2 additions & 2 deletions exported_requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -19,5 +19,5 @@ sympy==1.12 ; python_version >= "3.11" and python_version < "4.0"
types-pytz==2024.1.0.20240203 ; python_version >= "3.11" and python_version < "4.0"
types-pyyaml==6.0.12.12 ; python_version >= "3.11" and python_version < "4.0"
typing-extensions==4.9.0 ; python_version >= "3.11" and python_version < "4.0"
tzdata==2023.4 ; python_version >= "3.11" and python_version < "4.0" and sys_platform == "win32"
uuid6==2023.5.2 ; python_version >= "3.11" and python_version < "4.0"
tzdata==2024.1 ; python_version >= "3.11" and python_version < "4.0" and sys_platform == "win32"
uuid6==2024.1.12 ; python_version >= "3.11" and python_version < "4.0"
14 changes: 7 additions & 7 deletions poetry.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

18 changes: 12 additions & 6 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,27 +1,33 @@
[tool.poetry]
name = "django-woah"
version = "0.1.0"
description = "A package intended to aid developers in implementing authorization for their Django apps."
version = "0.1.1"
description = "A package intended to aid developers in implementing authorization for Django apps."
authors = ["Bogdan Petrea <bogdan@presslabs.com>"]
maintainers = ["Bogdan Petrea <bogdan@presslabs.com>"]
readme = "README.md"
license = "Apache-2.0"
packages = [
{ include = "django_woah" }
]
homepage = "https://github.com/presslabs/django-woah/"
repository = "https://github.com/presslabs/django-woah/"
keywords = [
"django-woah", "django", "woah", "authorization", "permission", "role", "organization",
"team", "drf", "rest-framework"
]

[tool.poetry.dependencies]
python = "^3.11"
django = "^4.2.6"
uuid6 = "^2023.5.2"
django = "^4.2.10"
uuid6 = "^2024.1.12"
djangorestframework = {version = "^3.14.0", optional = true}
sympy = "^1.12"

[tool.poetry.group.test.dependencies]
pytest = "^7.4.2"
pytest-django = "^4.5.2"
ruff = "^0.1.4"
django-stubs = "^4.2.6"
ruff = "^0.1.15"
django-stubs = "^4.2.7"
mypy = "^1.8.0"

[tool.poetry.extras]
Expand Down

0 comments on commit c83bb97

Please sign in to comment.