Skip to content

Commit 5a5d847

Browse files
authored
Merge pull request #25 from TypeError/update-v1.0
Merge v1.0.0 into the main branch
2 parents 9a96837 + 2197a6b commit 5a5d847

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

66 files changed

+5608
-2869
lines changed

.gitignore

+164-10
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,165 @@
1-
/build
2-
/dist
3-
/secure.egg-info
4-
.DS_Store
5-
__pycache__
6-
docs/build
7-
docs/source/_build
1+
# Byte-compiled / optimized / DLL files
2+
__pycache__/
3+
*.py[cod]
4+
*$py.class
5+
6+
# C extensions
7+
*.so
8+
9+
# Distribution / packaging
10+
.Python
11+
build/
12+
develop-eggs/
13+
dist/
14+
downloads/
15+
eggs/
16+
.eggs/
17+
lib/
18+
lib64/
19+
parts/
20+
sdist/
21+
var/
22+
wheels/
23+
share/python-wheels/
24+
*.egg-info/
25+
.installed.cfg
26+
*.egg
27+
MANIFEST
28+
29+
# PyInstaller
30+
# Usually these files are written by a python script from a template
31+
# before PyInstaller builds the exe, so as to inject date/other infos into it.
32+
*.manifest
33+
*.spec
34+
35+
# Installer logs
36+
pip-log.txt
37+
pip-delete-this-directory.txt
38+
39+
# Unit test / coverage reports
40+
htmlcov/
41+
.tox/
42+
.nox/
43+
.coverage
44+
.coverage.*
45+
.cache
46+
nosetests.xml
47+
coverage.xml
48+
*.cover
49+
*.py,cover
50+
.hypothesis/
51+
.pytest_cache/
52+
cover/
53+
54+
# Translations
55+
*.mo
56+
*.pot
57+
58+
# Django stuff:
59+
*.log
60+
local_settings.py
61+
db.sqlite3
62+
db.sqlite3-journal
63+
64+
# Flask stuff:
65+
instance/
66+
.webassets-cache
67+
68+
# Scrapy stuff:
69+
.scrapy
70+
71+
# Sphinx documentation
72+
docs/_build/
73+
74+
# PyBuilder
75+
.pybuilder/
76+
target/
77+
78+
# Jupyter Notebook
79+
.ipynb_checkpoints
80+
81+
# IPython
82+
profile_default/
83+
ipython_config.py
84+
85+
# pyenv
86+
# For a library or package, you might want to ignore these files since the code is
87+
# intended to run in multiple environments; otherwise, check them in:
88+
# .python-version
89+
90+
# pipenv
91+
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
92+
# However, in case of collaboration, if having platform-specific dependencies or dependencies
93+
# having no cross-platform support, pipenv may install dependencies that don't work, or not
94+
# install all needed dependencies.
95+
#Pipfile.lock
96+
97+
# poetry
98+
# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
99+
# This is especially recommended for binary packages to ensure reproducibility, and is more
100+
# commonly ignored for libraries.
101+
# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
102+
#poetry.lock
103+
104+
# pdm
105+
# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
106+
#pdm.lock
107+
# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
108+
# in version control.
109+
# https://pdm.fming.dev/latest/usage/project/#working-with-version-control
110+
.pdm.toml
111+
.pdm-python
112+
.pdm-build/
113+
114+
# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
115+
__pypackages__/
116+
117+
# Celery stuff
118+
celerybeat-schedule
119+
celerybeat.pid
120+
121+
# SageMath parsed files
122+
*.sage.py
123+
124+
# Environments
125+
.env
126+
.venv
127+
env/
128+
venv/
129+
ENV/
130+
env.bak/
131+
venv.bak/
132+
133+
# Spyder project settings
134+
.spyderproject
135+
.spyproject
136+
137+
# Rope project settings
138+
.ropeproject
139+
140+
# mkdocs documentation
141+
/site
142+
143+
# mypy
144+
.mypy_cache/
145+
.dmypy.json
146+
dmypy.json
147+
148+
# Pyre type checker
149+
.pyre/
150+
151+
# pytype static type analyzer
152+
.pytype/
153+
154+
# Cython debug symbols
155+
cython_debug/
156+
157+
# PyCharm
158+
# JetBrains specific template is maintained in a separate JetBrains.gitignore that can
159+
# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
160+
# and can be added to the global gitignore or merged into this file. For a more nuclear
161+
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
162+
#.idea/
8163
.idea
9-
.vscode
10-
.flake8
11-
*.pyc
164+
165+
.DS_Store

.readthedocs.yaml

-18
This file was deleted.

.travis.yml

-9
This file was deleted.

CHANGELOG.md

+70
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
# Changelog
2+
3+
All notable changes to this project will be documented in this file.
4+
5+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
6+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7+
8+
## [Unreleased]
9+
10+
- Placeholder for upcoming changes.
11+
12+
## [1.0.0] - 2024-09-27
13+
14+
### Breaking Changes
15+
16+
- Full redesign of the `secure.py` library with modern Python (3.10+) support.
17+
- Major API overhaul for improved usability and Pythonic design.
18+
19+
### Added
20+
21+
- Enhanced support for FastAPI and asynchronous frameworks.
22+
- Added type hints and better type annotations for a smoother developer experience.
23+
- Refined default security headers for improved protection across web frameworks.
24+
- Support for modern Python features such as the union operator (`|`) and `cached_property`.
25+
26+
## [0.3.0] - 2021-04-27
27+
28+
### Breaking Changes
29+
30+
- Full redesign of Secure API.
31+
- Removal of cookie support.
32+
33+
### Added
34+
35+
- Added type hints for better developer experience.
36+
- Added support for FastAPI.
37+
38+
### Changed
39+
40+
- Replaced Feature-Policy with Permissions-Policy (#10).
41+
42+
## [0.2.1] - 2018-12-24
43+
44+
### Added
45+
46+
- Added support for Masonite framework.
47+
- Added docstrings for `SecureHeaders` and `SecureCookie`.
48+
49+
### Changed
50+
51+
- Upper-cased SameSite enum to `SameSite.LAX` / `SameSite.STRICT`.
52+
- Modified hug implementation for SecureHeaders and SecureCookie.
53+
- Renamed `Feature.Values.All` to `Feature.Values.All_` to avoid conflict with the built-in `all`.
54+
55+
### Fixed
56+
57+
- Removed trailing semicolon from Feature Policy.
58+
59+
## [0.2.0] - 2018-12-16
60+
61+
### Added
62+
63+
- Added policy builder `SecurePolicies` in `policies.py`.
64+
- Added `Expires` header for legacy browser support.
65+
- Added `max-age` directive to `Cache-Control` header.
66+
67+
### Changed
68+
69+
- Renamed `XXS` argument to `XXP`.
70+
- Modified `set-cookie` to use Flask's native method.

LICENSE

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
MIT License
22

3-
Copyright (c) 2021 Caleb Kinney
3+
Copyright (c) 2018-2024 Caleb Kinney
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

MANIFEST.in

+2-3
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,2 @@
1-
include README.md LICENSE
2-
prune tests*
3-
prune docs*
1+
include LICENSE
2+
exclude tests/*

0 commit comments

Comments
 (0)