Skip to content

Commit

Permalink
Initial Public Release
Browse files Browse the repository at this point in the history
This is the Initial Public Release of the Python Software Foundation's consolidated and centralized policies.

It includes:

Imports of the following policy documents
  - PyPI.org Acceptable Use Policy
  - PyPI.org Code of Conduct
  - PyPI.org Terms of use
  - Python.org Code of Conduct
  - Python.org Contributing
  - Python.org Legal Statements
  - Python.org Privacy Policy
  - us.pycon.org Privacy and Data Policy
  - us.pycon.org Code of Conduct
  - us.pycon.org Code of Conduct Enforcement Procedures
  - us.pycon.org Code of Conduct Procedures for Reporting Incidents

As well as the following new policies:
  - Python.org Copyright Policy

This repository is a public mirror of a private repository. Releases from the private are squashed into single commits.
  • Loading branch information
ewdurbin committed May 3, 2023
0 parents commit 8d8126d
Show file tree
Hide file tree
Showing 22 changed files with 1,546 additions and 0 deletions.
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
/site

*.swp
13 changes: 13 additions & 0 deletions .readthedocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# .readthedocs.yaml
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

version: 2

build:
os: ubuntu-22.04
tools:
python: "3.11"
commands:
- python -m pip install -r requirements.txt
- python -m mkdocs build --clean --site-dir $READTHEDOCS_OUTPUT/html --config-file mkdocs.yml
25 changes: 25 additions & 0 deletions Dockerfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
FROM python:3.11.3-slim-bullseye as docs

RUN set -x \
&& apt-get update \
&& apt-get install --no-install-recommends -y \
build-essential git libcairo2-dev libfreetype6-dev \
libjpeg-dev libpng-dev libz-dev

RUN set -x \
&& python3 -m venv /opt/venv

ENV PATH="/opt/venv/bin:${PATH}"

RUN pip --no-cache-dir --disable-pip-version-check install \
--upgrade pip setuptools wheel
COPY requirements.txt /tmp/requirements.txt
RUN set -x \
&& pip --no-cache-dir --disable-pip-version-check \
install -r /tmp/requirements.txt \
&& pip check \
&& find /opt/venv -name '*.pyc' -delete

WORKDIR /opt/venv/src/
COPY mkdocs.yml /opt/venv/src/mkdocs.yml
COPY docs /opt/venv/src/docs
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Python Software Foundation Policies

This repository acts as the canonical source for the policies published by
the [Python Software Foundation](https://python.org/psf/).

## Development

You can use `docker compose up` to start development server with live-reloading as you
edit documents.

Once it has started, navigate to [http://localhost:10000](http://localhost:10000)
in your browser! Any edits made will render as you save your work.
17 changes: 17 additions & 0 deletions docker-compose.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
version: '3.9'

services:
docs:
build:
context: .
pull_policy: never
command: mkdocs serve -a 0.0.0.0:8000 -f mkdocs.yml
volumes:
- ./.git:/opt/venv/src/.git:z
- ./mkdocs.yml:/opt/venv/src/mkdocs.yml:z
- ./docs:/opt/venv/src/docs:z
- ./overrides:/opt/venv/src/overrides:z
environment:
- PREVIEW=True
ports:
- "10000:8000"
8 changes: 8 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
title: About
---

# About

This site serves as the canonical location for policies published by the
[Python Software Foundation](https://python.org/psf-landing/).
20 changes: 20 additions & 0 deletions docs/pypi.org/.readthedocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# .readthedocs.yaml
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

# Required
version: 2

# Set the version of Python and other tools you might need
build:
os: ubuntu-22.04
tools:
python: "3.11"

mkdocs:
configuration: mkdocs.yml

# Optionally declare the Python requirements required to build your docs
python:
install:
- requirements: requirements.txt
Loading

0 comments on commit 8d8126d

Please sign in to comment.