initial content

LICENSE.md

@@ -0,0 +1,55 @@
+# Blue Oak Model License
+
+Version 1.0.0
+
+## Purpose
+
+This license gives everyone as much permission to work with
+this software as possible, while protecting contributors
+from liability.
+
+## Acceptance
+
+In order to receive this license, you must agree to its
+rules.  The rules of this license are both obligations
+under that agreement and conditions to your license.
+You must not do anything with this software that triggers
+a rule that you cannot or will not follow.
+
+## Copyright
+
+Each contributor licenses you to do everything with this
+software that would otherwise infringe that contributor's
+copyright in it.
+
+## Notices
+
+You must ensure that everyone who gets a copy of
+any part of this software from you, with or without
+changes, also gets the text of this license or a link to
+<https://blueoakcouncil.org/license/1.0.0>.
+
+## Excuse
+
+If anyone notifies you in writing that you have not
+complied with [Notices](#notices), you can keep your
+license by taking all practical steps to comply within 30
+days after the notice.  If you do not do so, your license
+ends immediately.
+
+## Patent
+
+Each contributor licenses you to do everything with this
+software that would otherwise infringe any patent claims
+they can license or become able to license.
+
+## Reliability
+
+No contributor can revoke this license.
+
+## No Liability
+
+***As far as the law allows, this software comes as is,
+without any warranty or condition, and no contributor
+will be liable to anyone for any damages related to this
+software or this license, under any kind of legal claim.***

README.md

@@ -0,0 +1,6 @@
+# Pallets Projects Website
+
+This is the code and content for https://palletsprojects.com. Static content
+from the `content` folder is loaded when the server is started then served
+quickly from memory or cache. This allows editing content as plain files like a
+static site, while also taking advantage of Python and a full application.

content/code-of-conduct.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[email protected]. Content on GitHub may also be reported through its
+interface. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

content/contact.md

@@ -0,0 +1,57 @@
+# Contact
+
+There are multiple ways to get help in the community or get in contact with the
+team. Regardless of the venue, you must agree to follow our
+[Code of Conduct](code-of-conduct.md).
+
+## Chat on Discord
+
+We use Discord for our chat platform. Anyone may join using this link:
+https://discord.gg/pallets. Use the `#questions` channel for questions about
+your own projects that use any of our libraries; do not post images of code, and
+use a paste site like https://dpaste.com for long blocks of code. Use the
+`#random` channel to post about projects, libraries, and programming news.
+
+The project-specific channels are reserved for contributor discussion, not for
+general questions. If you are contributing to one of our projects and need to
+discuss anything, use the `#get-access` channel to be able to post.  
+
+The IRC channel ``#pallets`` on https://libera.chat is connected to the
+``#questions`` channel on Discord. In Discord you'll see a `bot` label for IRC
+users; in IRC you'll see a `Pallets-`` prefix for Discord users.
+
+## GitHub Discussions
+
+You may use a project's GitHub Discussions tab to ask questions. This is more
+permanent than chat, and allows feedback and accepting answers.
+
+## Reporting Security Issues
+
+Responsibly report security issues by [drafting a private security advisory][advisory]
+on GitHub, or email us at [email protected]. See our
+[Security Policy](security.md) for details.
+
+[advisory]: https://docs.github.com/code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability#privately-reporting-a-security-vulnerability
+
+## Reporting Conduct Issues
+
+You may confidentially report [Code of Conduct](code-of-conduct.md) issues that
+occur in any venue by emailing us at [email protected]. If the issue
+occurred on GitHub, you may also report content through its interface. If there
+is a public issue on Discord, you may ping the `@moderators` group.
+
+## Email
+
+To email us about anything that is not related to security or conduct, use our
+general email, [email protected].
+
+## Twitter
+
+We do not currently use Twitter. Our account `@PalletsTeam` is currently
+private.
+
+## Stack Overflow
+
+Some of our community members are active on Stack Overflow. However, Pallets
+does not actively monitor questions, and cannot vouch for answer quality in
+general. Always seek out official documentation first.

content/contributing/docs.md

@@ -0,0 +1,17 @@
+# Contribute to Documentation
+
+We use [Sphinx][] and [ReStructuredText][] to write the documentation. 
+To build the docs locally, change to the `docs` directory and run `make html`.
+
+Open `_build/html/index.html` in your browser to view the docs.
+
+Build the docs in the ``docs`` directory using Sphinx.
+
+.. code-block:: text
+
+    $ cd docs
+    $ make html
+
+Open ``_build/html/index.html`` in your browser to view the docs.
+
+Read more about `Sphinx <https://www.sphinx-doc.org/en/stable/>`__.

content/contributing/environment.md

@@ -0,0 +1,84 @@
+# Development Environment
+
+Every project uses the same project layout and tools. It is helpful to be aware
+of them and their documentation when contributing.
+
+## Requirements Files
+
+Each development environment uses a requirements file and the [pip-tools][] and
+[pip-compile-multi][] tools to pin versions. This ensures that tests and builds
+are reproducible when setting up a new environment or looking at previous tags.
+
+The `requirements` folder contains `.in` files that list the direct, unpinned
+requirements for each environment. pip-compile-multi uses the `.in` files to
+generate `.txt` files that pin the entire dependency tree.
+
+We do not use Dependabot to update these files as it is too noisy.
+
+[pip-tools]: https://pip-tools.readthedocs.io
+[pip-compile-multi]: https://pip-compile-multi.readthedocs.io
+
+## Tests
+
+[pytest][] is used to run the tests, found in the `tests` folder.
+
+[tox][] is used to run different test environments, including Python versions,
+style checks, documentation, and typing. The `tox.ini` file configures this.
+
+We do not currently run [coverage][]. While our test suite is fairly robust,
+we don't have consistent enough coverage to make the reports useful at this
+time. We found that it does not impact our release quality.
+
+[mypy][] is used for static type checking. Other tools may not give the same
+results.
+
+See [here](tests.md) for information about writing, running, and improving
+tests and test coverage.
+
+[pytest]: https://docs.pytest.org
+[tox]: https://tox.wiki
+[coverage]: https://coverage.readthedocs.io
+[mypy]: https://mypy.readthedocs.io
+
+## Documentation
+
+[Sphinx][] is used to build the documentation. The `docs` folder contains `.rst`
+files, which are [ReStructuredText][].
+
+[Pallets-Sphinx-Themes][] contains the designs and extensions the projects use.
+
+The docs are built and hosted on [Read the Docs][]. It will also check that the
+docs build for pull requests.
+
+See [here](docs.md) for information about writing and building documentation.
+
+[Sphinx]: https://www.sphinx-doc.org
+[Pallets-Sphinx-Themes]: https://github.com/pallets/pallets-sphinx-themes
+[Read the Docs]: https://readthedocs.org
+
+## Code Style
+
+Code style tools are run automatically on each commit using [pre-commit][].
+The `.pre-commit-config.yaml` file pins the versions of each tool.
+[pre-commit.ci][] runs these checks and commits fixes automatically on pull
+requests. It will also make PRs to update the pinned versions each month.
+
+See [setup](setup.md) for how to enable pre-commit.
+
+[black][] enforces code formatting.
+
+[flake8][] enforces style "lint" rules. [flake8-bugbear][] catches more
+opinionated rules.
+
+[pyupgrade][] enforces using modern syntax for the Python versions we support.
+
+[reorder_python_imports][] enforces a standard format and order for all imports
+at the top of files.
+
+[pre-commit]: https://pre-commit.com
+[pre-commit.ci]: https://pre-commit.ci
+[black]: https://black.readthedocs.io
+[flake8]: https://flake8.pycqa.org
+[flake8-bugbear]: https://github.com/PyCQA/flake8-bugbear
+[pyupgrade]: https://github.com/asottile/pyupgrade
+[reorder_python_imports]: https://github.com/asottile/reorder-python-imports

content/contributing/features.md

@@ -0,0 +1 @@
+# Request a Feature