ctftime-api 0.1.3__tar.gz → 0.1.4__tar.gz

ctftime_api-0.1.4/.github/dependabot.yml

@@ -0,0 +1,27 @@
+version: 2
+updates:
+  - package-ecosystem: "pip" # See documentation for possible values
+    directory: "/" # Location of package manifests
+    reviewers:
+      - "jotonedev"
+    groups:
+      dependencies:
+        patterns:
+          - "*"  # Group all updates together
+    schedule:
+      interval: "weekly" # How often to check for updates
+    commit-message:
+      prefix: "[poetry] "
+
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    reviewers:
+      - "jotonedev"
+    groups:
+      dependencies:
+        patterns:
+          - "*"
+    schedule:
+      interval: "weekly"
+    commit-message:
+      prefix: "[action] "

ctftime_api-0.1.4/.github/workflows/cleanup.yml

@@ -0,0 +1,29 @@
+name: Cleanup caches
+on:
+  pull_request:
+    types:
+      - closed
+
+jobs:
+  cleanup:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Cleanup
+        run: |
+          gh extension install actions/gh-actions-cache
+
+          echo "Fetching list of cache key"
+          cacheKeysForPR=$(gh actions-cache list -R $REPO -B $BRANCH -L 100 | cut -f 1 )
+
+          ## Setting this to not fail the workflow while deleting cache keys.
+          set +e
+          echo "Deleting caches..."
+          for cacheKey in $cacheKeysForPR
+          do
+              gh actions-cache delete $cacheKey -R $REPO -B $BRANCH --confirm
+          done
+          echo "Done"
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          REPO: ${{ github.repository }}
+          BRANCH: refs/pull/${{ github.event.pull_request.number }}/merge

ctftime_api-0.1.4/.github/workflows/codeql.yml

@@ -0,0 +1,37 @@
+name: "CodeQL"
+
+on:
+  workflow_dispatch:
+
+jobs:
+  analyze:
+    name: Analyze (${{ matrix.language }})
+    runs-on: 'ubuntu-latest'
+    permissions:
+      # required for all workflows
+      security-events: write
+      # required to fetch internal or private CodeQL packs
+      packages: read
+
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - language: python
+            build-mode: none
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      # Initializes the CodeQL tools for scanning.
+      - name: Initialize CodeQL
+        uses: github/codeql-action/init@v3
+        with:
+          languages: ${{ matrix.language }}
+          build-mode: ${{ matrix.build-mode }}
+          queries: security-extended,security-and-quality
+
+      - name: Perform CodeQL Analysis
+        uses: github/codeql-action/analyze@v3
+        with:
+          category: "/language:${{matrix.language}}"

ctftime_api-0.1.4/.github/workflows/docs.yml

@@ -0,0 +1,71 @@
+name: Update docs
+
+on:
+  pull_request:
+    types: [opened, synchronize, reopened]
+  push:
+    tags:
+      - 'v*.*.*'
+  workflow_dispatch:
+    inputs:
+      upload:
+        description: 'Update documentation'
+        required: false
+        type: boolean
+        default: false
+
+jobs:
+  build:
+    name: Build the docs
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
+        with:
+          enable-cache: true
+          cache-dependency-glob: "uv.lock"
+          version: "latest"
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install the project
+        run: uv sync --group docs
+
+      - name: Set git credentials
+        run: |
+          git config --global user.name "${{ github.actor }}"
+          git config --global user.email "${{ github.actor }}@users.noreply.github.com"
+
+      - name: Build the docs
+        id: build
+        run: uv run mkdocs build
+
+      - name: Upload docs
+        if: github.event_name == 'push' && github.ref == 'refs/heads/main'
+        id: deployment
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: site/
+
+  deploy:
+    name: Deploy the docs
+    runs-on: ubuntu-latest
+    needs: build
+    if: ${{ (github.event.inputs.upload || github.ref_type == 'tag') }}
+
+    permissions:
+      contents: read
+      id-token: write
+      pages: write
+
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

ctftime_api-0.1.4/.github/workflows/publish.yml

@@ -0,0 +1,81 @@
+name: Publish release
+
+on:
+  push:
+    tags:
+      - 'v*.*.*'
+  workflow_dispatch:
+    inputs:
+      upload:
+        description: 'Upload release to PyPI'
+        required: false
+        type: boolean
+        default: false
+
+permissions:
+  contents: read
+
+jobs:
+  release-build:
+    name: Build the release
+    runs-on: ubuntu-latest
+
+    permissions:
+      contents: read
+      id-token: write
+      attestations: write
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
+        with:
+          enable-cache: true
+          cache-dependency-glob: "uv.lock"
+          version: "latest"
+
+      - name: Install the project
+        run: uv sync --no-group docs --no-group dev
+
+      - name: Package project
+        run: uv build -o dist/
+
+      - name: Sign build artifacts
+        uses: actions/attest-build-provenance@v2
+        with:
+          subject-path: "dist/*"
+
+      - name: Upload build artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: release-dists
+          retention-days: 1
+          path: "dist/"
+
+
+  pypi-publish:
+    name: Publish to PyPI
+    runs-on: ubuntu-latest
+    needs: release-build
+    if: ${{ (github.event.inputs.upload || github.ref_type == 'tag') }}
+
+    permissions:
+      contents: read
+      id-token: write
+
+    environment:
+      name: pypi
+
+    steps:
+      - name: Retrieve release distributions
+        uses: actions/download-artifact@v4
+        with:
+          name: release-dists
+          path: dist/
+
+      - name: Publish package distributions to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          attestations: true

ctftime_api-0.1.4/.github/workflows/test.yml

@@ -0,0 +1,67 @@
+# This workflow will install Python dependencies, run tests and lint with a variety of Python versions
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python
+
+name: Test code
+
+on:
+  workflow_dispatch:
+  push:
+  pull_request:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    continue-on-error: false
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: [ "3.11", "3.12", "3.13"]
+
+    permissions:
+      pull-requests: write
+      contents: read
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
+        with:
+          enable-cache: true
+          cache-dependency-glob: "uv.lock"
+          version: "latest"
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install the project
+        run: uv sync --all-extras --group dev --no-group docs
+
+      - name: Lint with ruff
+        id: lint
+        if: matrix.python-version == '3.13'
+        run: uv run ruff check -v
+
+      - name: Check formatting with ruff
+        id: check
+        if: matrix.python-version == '3.13'
+        run: uv run ruff format --check
+
+      - name: Test code
+        id: test
+        run: uv run pytest
+
+      - name: Test code with coverage
+        id: coverage
+        if: matrix.python-version == '3.13'
+        run: uv run coverage run -m pytest && uv run coverage report -m && uv run coverage xml
+        continue-on-error: true
+
+      - name: Upload coverage for pull requests
+        if: matrix.python-version == '3.13' && github.event_name == 'pull_request'
+        uses: orgoro/coverage@v3.2
+        with:
+          coverageFile: ./coverage.xml
+          token: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Check types
+        id: typing
+        run: uv run mypy -p ctftime_api

ctftime_api-0.1.4/.gitignore

@@ -0,0 +1,143 @@
+# 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
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__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/
+
+# End of https://mrkandreev.name/snippets/gitignore-generator/#Python
+
+.idea/
+.vscode/

{ctftime_api-0.1.3 → ctftime_api-0.1.4}/PKG-INFO

@@ -1,15 +1,17 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.4
 Name: ctftime_api
-Version: 0.1.3
+Version: 0.1.4
 Summary: CTFTime API wrapper
-Keywords: ctftime,api,wrapper
-Author: John Toniutti
-Author-email: john.toniutti@gmail.com
-Requires-Python: >=3.11
+Project-URL: repository, https://github.com/jotonedev/ctftime_api
+Project-URL: documentation, https://jotonedev.github.io/ctftime_api/
+Author-email: John Toniutti <john.toniutti@gmail.com>
+License-Expression: GPL-3.0-or-later
+License-File: LICENSE
+Keywords: api,ctftime,wrapper
 Classifier: Development Status :: 4 - Beta
+Classifier: Framework :: Pydantic
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
-Classifier: Framework :: Pydantic
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.11
@@ -18,18 +20,17 @@ Classifier: Programming Language :: Python :: 3.13
 Classifier: Topic :: Internet :: WWW/HTTP
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Requires-Dist: httpx<0.29.0,>=0.28.1
+Requires-Dist: pycountry<25.0.0,>=24.6.1
+Requires-Dist: pydantic-extra-types<3.0.0,>=2.10.2
+Requires-Dist: pydantic<3.0.0,>=2.10.6
 Provides-Extra: speed
-Requires-Dist: brotli (>=1.1.0,<2.0.0) ; (platform_python_implementation == "CPython") and (extra == "speed")
-Requires-Dist: brotlicffi (>=1.1.0.0,<2.0.0.0) ; (platform_python_implementation != "CPython") and (extra == "speed")
-Requires-Dist: h2 (>=4.2.0,<5.0.0) ; extra == "speed"
-Requires-Dist: httpx (>=0.28.1,<0.29.0)
-Requires-Dist: pycountry (>=24.6.1,<25.0.0)
-Requires-Dist: pydantic (>=2.10.6,<3.0.0)
-Requires-Dist: pydantic-extra-types (>=2.10.2,<3.0.0)
-Requires-Dist: uvloop (>=0.21.0,<1.0.0) ; (sys_platform != "win32") and (extra == "speed")
-Requires-Dist: zstandard (>=0.23.0,<0.24.0) ; extra == "speed"
-Project-URL: Documentation, https://jotonedev.github.io/ctftime_api/
-Project-URL: Repository, https://github.com/jotonedev/ctftime_api
+Requires-Dist: brotli<2.0.0,>=1.1.0; (platform_python_implementation == 'CPython') and extra == 'speed'
+Requires-Dist: brotlicffi<2.0.0.0,>=1.1.0.0; (platform_python_implementation != 'CPython') and extra == 'speed'
+Requires-Dist: h2<5.0.0,>=4.2.0; extra == 'speed'
+Requires-Dist: uvloop<1.0.0,>=0.21.0; (sys_platform != 'win32') and extra == 'speed'
+Requires-Dist: zstandard<0.24.0,>=0.23.0; extra == 'speed'
 Description-Content-Type: text/markdown
 
 # ctftime_api
@@ -96,3 +97,6 @@ This project is licensed under the GNU General Public License v3 or later (GPLv3
 - [Project Documentation Website](https://jotonedev.github.io/ctftime_api)
 - [GitHub Repository](https://github.com/jotonedev/ctftime_api)
 
+## License
+
+This project is released under the [GPL 3.0 or later](LICENSE) license.

{ctftime_api-0.1.3 → ctftime_api-0.1.4}/README.md

@@ -61,3 +61,7 @@ This project is licensed under the GNU General Public License v3 or later (GPLv3
 
 - [Project Documentation Website](https://jotonedev.github.io/ctftime_api)
 - [GitHub Repository](https://github.com/jotonedev/ctftime_api)
+
+## License
+
+This project is released under the [GPL 3.0 or later](LICENSE) license.

ctftime_api-0.1.4/docs/api/client.md

@@ -0,0 +1,8 @@
+---
+title: Client module
+summary: Provides the main interface to the API.
+---
+
+The Client module provides the main interface to the API.
+
+::: ctftime_api.CTFTimeClient

ctftime_api-0.1.4/docs/api/models/duration.md

@@ -0,0 +1,8 @@
+---
+title: Duration
+summary: Provides a dataclass for representing a duration in hours and days.
+---
+
+Provides a dataclass for representing a duration in hours and days.
+
+::: ctftime_api.models.duration.Duration

ctftime_api-0.1.4/docs/api/models/event.md

@@ -0,0 +1,8 @@
+---
+title: Event module
+summary: Provides the Event objects
+---
+
+::: ctftime_api.models.event.Event
+
+::: ctftime_api.models.event.EventResult

ctftime_api-0.1.4/docs/api/models/rating.md

@@ -0,0 +1,8 @@
+---
+title: Rating
+summary: Provides a dataclass for representing a CTF team rating.
+---
+
+Provides a dataclass for representing a CTF team rating.
+
+::: ctftime_api.models.rating.Rating

ctftime_api-0.1.4/docs/api/models/team.md

@@ -0,0 +1,24 @@
+---
+title: Team
+summary: Provides dataclasses for representing a CTF team and its related information.
+---
+
+Provides dataclasses for representing a CTF team and its related information.
+
+::: ctftime_api.models.team.BaseTeam
+
+::: ctftime_api.models.team.Team
+    options:
+        show_inheritance_diagram: true
+
+::: ctftime_api.models.team.TeamRank
+    options:
+        show_inheritance_diagram: true
+
+::: ctftime_api.models.team.TeamComplete
+    options:
+        show_inheritance_diagram: true
+
+::: ctftime_api.models.team.TeamResult
+    options:
+        show_inheritance_diagram: true

ctftime_api-0.1.4/docs/api/models/vote.md

@@ -0,0 +1,8 @@
+---
+title: Vote
+summary: Provides a dataclass for representing a vote to a CTF.
+---
+
+Provides a dataclass for representing a vote to a CTF.
+
+::: ctftime_api.models.vote.Vote

ctftime_api-0.1.4/docs/index.md

@@ -0,0 +1,17 @@
+# Introduction
+
+## Description
+
+### What is ctftime_api?
+
+`ctftime_api` is a simple Python wrapper for the CTFTime API.
+
+## Features
+
+- Fully type annotated
+- Asynchronous
+- Easy to use
+
+## Manuals
+
+- Official CTFtime API documentation: [CTFtime docs](https://ctftime.org/api/)