Merge pull request #25 from TypeError/update-v1.0

Merge v1.0.0 into the main branch

.gitignore

@@ -1,11 +1,165 @@
-/build
-/dist
-/secure.egg-info
-.DS_Store
-__pycache__
-docs/build
-docs/source/_build
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
 .idea
-.vscode
-.flake8
-*.pyc
+
+.DS_Store

CHANGELOG.md

@@ -0,0 +1,70 @@
+# Changelog
+
+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).
+
+## [Unreleased]
+
+- Placeholder for upcoming changes.
+
+## [1.0.0] - 2024-09-27
+
+### Breaking Changes
+
+- Full redesign of the `secure.py` library with modern Python (3.10+) support.
+- Major API overhaul for improved usability and Pythonic design.
+
+### Added
+
+- Enhanced support for FastAPI and asynchronous frameworks.
+- Added type hints and better type annotations for a smoother developer experience.
+- Refined default security headers for improved protection across web frameworks.
+- Support for modern Python features such as the union operator (`|`) and `cached_property`.
+
+## [0.3.0] - 2021-04-27
+
+### Breaking Changes
+
+- Full redesign of Secure API.
+- Removal of cookie support.
+
+### Added
+
+- Added type hints for better developer experience.
+- Added support for FastAPI.
+
+### Changed
+
+- Replaced Feature-Policy with Permissions-Policy (#10).
+
+## [0.2.1] - 2018-12-24
+
+### Added
+
+- Added support for Masonite framework.
+- Added docstrings for `SecureHeaders` and `SecureCookie`.
+
+### Changed
+
+- Upper-cased SameSite enum to `SameSite.LAX` / `SameSite.STRICT`.
+- Modified hug implementation for SecureHeaders and SecureCookie.
+- Renamed `Feature.Values.All` to `Feature.Values.All_` to avoid conflict with the built-in `all`.
+
+### Fixed
+
+- Removed trailing semicolon from Feature Policy.
+
+## [0.2.0] - 2018-12-16
+
+### Added
+
+- Added policy builder `SecurePolicies` in `policies.py`.
+- Added `Expires` header for legacy browser support.
+- Added `max-age` directive to `Cache-Control` header.
+
+### Changed
+
+- Renamed `XXS` argument to `XXP`.
+- Modified `set-cookie` to use Flask's native method.

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2021 Caleb Kinney
+Copyright (c) 2018-2024 Caleb Kinney
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

MANIFEST.in

@@ -1,3 +1,2 @@
-include README.md LICENSE
-prune tests*
-prune docs*
+include LICENSE
+exclude tests/*