Merge pull request #23 from ceph/pyscaffold

Use PyScaffold to set up a project structure

.coveragerc

@@ -0,0 +1,28 @@
+# .coveragerc to control coverage.py
+[run]
+branch = True
+source = teuthology_api
+# omit = bad_file.py
+
+[paths]
+source =
+    src/
+    */site-packages/
+
+[report]
+# Regexes for lines to exclude from consideration
+exclude_lines =
+    # Have to re-enable the standard pragma
+    pragma: no cover
+
+    # Don't complain about missing debug-only code:
+    def __repr__
+    if self\.debug
+
+    # Don't complain if tests don't hit defensive assertion code:
+    raise AssertionError
+    raise NotImplementedError
+
+    # Don't complain if non-runnable code isn't run:
+    if 0:
+    if __name__ == .__main__.:

.env.dev

@@ -10,6 +10,6 @@ GH_TOKEN_URL='https://github.com/login/oauth/access_token'
 GH_FETCH_MEMBERSHIP_URL='https://api.github.com/user/memberships/orgs/ceph'
 
 #Session Related Stuff
-## SESSION_SECRET_KEY is used to encrypt session data 
+## SESSION_SECRET_KEY is used to encrypt session data
 ## and it's prod value should be kept secret.
-SESSION_SECRET_KEY=my-secret-key
+SESSION_SECRET_KEY=my-secret-key

.github/workflows/black.yaml

@@ -10,4 +10,4 @@ jobs:
       - uses: psf/black@stable
         with:
           options: "--check --verbose"
-          src: "./src"
+          src: "./src"

.github/workflows/integration.yaml

@@ -8,4 +8,4 @@ jobs:
       - uses: actions/checkout@v2
       - name: Start teuthology & teuthology-api
         run: ./start.sh
-        working-directory: ./gh-actions
+        working-directory: ./gh-actions

.gitignore

@@ -1,63 +1,55 @@
-.vscode/
-# Byte-compiled / optimized / DLL files
-__pycache__/
+# Temporary and binary files
+*~
 *.py[cod]
-*$py.class
-
-# C extensions
 *.so
-
-# Distribution / packaging
-.Python
-build/
-develop-eggs/
-dist/
-downloads/
-eggs/
-.eggs/
-lib/
-lib64/
-parts/
-sdist/
-var/
-wheels/
-pip-wheel-metadata/
-share/python-wheels/
-*.egg-info/
-.installed.cfg
+*.cfg
+!.isort.cfg
+!setup.cfg
+*.orig
+*.log
+*.pot
+__pycache__/*
+.cache/*
+.*.swp
+*/.ipynb_checkpoints/*
+.DS_Store
+
+# Project files
+.ropeproject
+.project
+.pydevproject
+.settings
+.idea
+.vscode
+tags
+
+# Package files
 *.egg
+*.eggs/
+.installed.cfg
+*.egg-info
+
+# Unittest and coverage
+htmlcov/*
+.coverage
+.coverage.*
+.tox
+junit*.xml
+coverage.xml
+.pytest_cache/
+
+# Build and docs folder/files
+build/*
+dist/*
+sdist/*
+docs/api/*
+docs/_rst/*
+docs/_build/*
+cover/*
 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
-
-# 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
-
-# PEP 582; used by e.g. github.com/David-OConnor/pyflow
-__pypackages__/
-
-# Environments
-.env
-.venv
-env/
-venv/
-ENV/
-env.bak/
-venv.bak/
-
-# mypy
-.mypy_cache/
-.dmypy.json
-dmypy.json
+# Per-project virtualenvs
+.venv*/
+.conda*/
+.python-version
+venv

.pre-commit-config.yaml

@@ -0,0 +1,11 @@
+repos:
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v2.3.0
+    hooks:
+    -   id: check-yaml
+    -   id: end-of-file-fixer
+    -   id: trailing-whitespace
+-   repo: https://github.com/psf/black
+    rev: 22.10.0
+    hooks:
+    -   id: black

.readthedocs.yml

@@ -0,0 +1,27 @@
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+  configuration: docs/conf.py
+
+# Build documentation with MkDocs
+#mkdocs:
+#  configuration: mkdocs.yml
+
+# Optionally build your docs in additional formats such as PDF
+formats:
+  - pdf
+
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.11"
+
+python:
+  install:
+    - requirements: docs/requirements.txt
+    - {path: ., method: pip}

.teuthology.yaml

@@ -4,4 +4,4 @@ lock_server: http://paddles:8080
 results_server: http://paddles:8080
 results_ui_server: http://pulpito:8081/
 reserve_machines: 0
-lab_domain: ''
+lab_domain: ''

AUTHORS.md

@@ -0,0 +1,6 @@
+# Contributors
+
+* Vallari Agrawal [[email protected]](mailto:[email protected])
+* Kamoltat Sirivadhna [[email protected]](mailto:[email protected])
+* Devansh3712 [[email protected]](mailto:[email protected])
+* Zack Cerza [[email protected]](mailto:[email protected])

CHANGELOG.md

@@ -0,0 +1,7 @@
+# Changelog
+
+## Version 0.1 (development)
+
+- Feature A added
+- FIX: nasty bug #1729 fixed
+- add your changes here!