From c99c9eb10206b19be17c84e88eb37c8916d7827b Mon Sep 17 00:00:00 2001 From: Shane <6071159+smashedr@users.noreply.github.com> Date: Sat, 29 Nov 2025 13:16:03 -0800 Subject: [PATCH] Update Docs Example --- .gitattributes | 5 +++-- .github/assets/logo.svg | 4 ++++ .github/workflows/build.yaml | 2 +- .github/workflows/release.yaml | 3 +++ .gitignore | 1 + README.md | 2 +- docs/index.md | 4 +++- pyproject.toml | 2 ++ 8 files changed, 18 insertions(+), 5 deletions(-) create mode 100644 .github/assets/logo.svg diff --git a/.gitattributes b/.gitattributes index 217ed8e..5e0f547 100644 --- a/.gitattributes +++ b/.gitattributes @@ -1,2 +1,3 @@ -docs/syntax-highlighting.css linguist-generated -docs/theme.css linguist-generated +docs/** linguist-documentation +docs.ps1 linguist-vendored +build.ps1 linguist-vendored diff --git a/.github/assets/logo.svg b/.github/assets/logo.svg new file mode 100644 index 0000000..de134d5 --- /dev/null +++ b/.github/assets/logo.svg @@ -0,0 +1,4 @@ + + + + diff --git a/.github/workflows/build.yaml b/.github/workflows/build.yaml index 92a7c85..0371331 100644 --- a/.github/workflows/build.yaml +++ b/.github/workflows/build.yaml @@ -20,7 +20,7 @@ jobs: steps: - name: "Checkout" - uses: actions/checkout@v5 + uses: actions/checkout@v6 - name: "Debug event.json" continue-on-error: true diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml index c575493..6c917d7 100644 --- a/.github/workflows/release.yaml +++ b/.github/workflows/release.yaml @@ -159,6 +159,9 @@ jobs: uses: smashedr/update-release-notes-action@master with: location: tail + pypi: | + name: vultr-python + prerelease: ${{ github.event.release.prerelease }} - name: "Send Failure Notification" if: ${{ failure() }} diff --git a/.gitignore b/.gitignore index 08b9fdc..46aea92 100644 --- a/.gitignore +++ b/.gitignore @@ -16,3 +16,4 @@ coverage.xml site/ .cache/ # App +.secrets diff --git a/README.md b/README.md index 198deaf..06c1747 100644 --- a/README.md +++ b/README.md @@ -86,7 +86,7 @@ Get the OS list and filter by name ```python os_list = vultr.list_os() -ubuntu_lts = vultr.filter_os(os_list, 'Ubuntu 20.04 x64') +ubuntu_lts = vultr.filter_os(os_list, 'Ubuntu 24.04 LTS x64') ``` Create a new ssh key from key string diff --git a/docs/index.md b/docs/index.md index c27277d..2cab29c 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,8 +1,10 @@ [![PyPI Version](https://img.shields.io/pypi/v/vultr-python?logo=pypi&logoColor=white&label=pypi)](https://pypi.org/project/vultr-python/) +[![TOML Python Version](https://img.shields.io/badge/dynamic/toml?url=https%3A%2F%2Fraw.githubusercontent.com%2Fcssnr%2Fvultr-python%2Frefs%2Fheads%2Fmaster%2Fpyproject.toml&query=%24.project.requires-python&logo=python&logoColor=white&label=python)](https://github.com/cssnr/vultr-python?tab=readme-ov-file#readme) [![PyPI Downloads](https://img.shields.io/pypi/dm/vultr-python?logo=pypi&logoColor=white)](https://pypistats.org/packages/vultr-python) [![Pepy Total Downloads](https://img.shields.io/pepy/dt/vultr-python?logo=pypi&logoColor=white&label=total)](https://clickpy.clickhouse.com/dashboard/vultr-python) [![Codacy Badge](https://app.codacy.com/project/badge/Grade/9b356c4327df41e395c81de1c717ce11)](https://app.codacy.com/gh/cssnr/vultr-python/dashboard) [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=cssnr_vultr-python&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=cssnr_vultr-python) +[![GitHub Issues](https://img.shields.io/github/issues/cssnr/vultr-python?logo=github)](https://github.com/cssnr/vultr-python/issues) [![GitHub Contributors](https://img.shields.io/github/contributors-anon/cssnr/vultr-python?logo=github)](https://github.com/cssnr/vultr-python/graphs/contributors) [![GitHub Discussions](https://img.shields.io/github/discussions/cssnr/vultr-python?logo=github)](https://github.com/cssnr/vultr-python/discussions) [![GitHub Forks](https://img.shields.io/github/forks/cssnr/vultr-python?style=flat&logo=github)](https://github.com/cssnr/vultr-python/forks) @@ -62,7 +64,7 @@ Get the OS list and filter by name ```python os_list = vultr.list_os() -ubuntu_lts = vultr.filter_os(os_list, 'Ubuntu 20.04 x64') +ubuntu_lts = vultr.filter_os(os_list, 'Ubuntu 24.04 LTS x64') ``` Create a new ssh key from key string diff --git a/pyproject.toml b/pyproject.toml index 052de90..47d3620 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -48,7 +48,9 @@ Homepage = "https://cssnr.com/" Documentation = "https://cssnr.github.io/vultr-python" Source = "https://github.com/cssnr/vultr-python" Issues = "https://github.com/cssnr/vultr-python/issues" +Changelog = "https://github.com/cssnr/vultr-python/releases" Funding = "https://ko-fi.com/cssnr" +Discord = "https://discord.gg/wXy6m2X8wY" # Setup Tools #[tool.setuptools.package-data]