From 5e82fabe71fc8c4d9f90118b0494a87c012c3e82 Mon Sep 17 00:00:00 2001 From: Riley Rice Date: Thu, 29 Jan 2026 20:05:26 -0800 Subject: [PATCH] chore: update to be OSS and publish to pypi --- .github/workflows/ci.yml | 2 +- .github/workflows/publish.yml | 65 ++++++++ LICENSE | 190 ++++++++++++++++++++++++ Makefile | 6 +- README.md | 23 ++- {src/dotfiles => dotfiles}/__init__.py | 0 {src/dotfiles => dotfiles}/cli.py | 0 {src/dotfiles => dotfiles}/config.py | 0 {src/dotfiles => dotfiles}/installer.py | 0 pyproject.toml | 36 ++++- tests/test_config.py | 1 - tests/test_installer.py | 1 - 12 files changed, 308 insertions(+), 16 deletions(-) create mode 100644 .github/workflows/publish.yml create mode 100644 LICENSE rename {src/dotfiles => dotfiles}/__init__.py (100%) rename {src/dotfiles => dotfiles}/cli.py (100%) rename {src/dotfiles => dotfiles}/config.py (100%) rename {src/dotfiles => dotfiles}/installer.py (100%) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 5c38cc1..4d819e0 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -22,7 +22,7 @@ jobs: pip install -e ".[dev]" - name: Check formatting - run: ruff format --check src tests + run: ruff format --check dotfiles tests - name: Lint run: make lint diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml new file mode 100644 index 0000000..b42294b --- /dev/null +++ b/.github/workflows/publish.yml @@ -0,0 +1,65 @@ +name: Release and Publish + +on: + push: + tags: + - "*.*.*" + +jobs: + release: + runs-on: ubuntu-latest + permissions: + contents: write + outputs: + release_created: ${{ steps.create_release.outputs.id }} + steps: + - uses: actions/checkout@v4 + with: + fetch-depth: 0 + + - name: Create Release + id: create_release + uses: softprops/action-gh-release@v2 + with: + generate_release_notes: true + draft: false + prerelease: ${{ contains(github.ref, '-') }} + + build: + needs: release + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + + - name: Set up Python + uses: actions/setup-python@v5 + with: + python-version: "3.12" + + - name: Install build dependencies + run: pip install build + + - name: Build package + run: python -m build + + - name: Upload artifacts + uses: actions/upload-artifact@v4 + with: + name: dist + path: dist/ + + publish: + needs: build + runs-on: ubuntu-latest + environment: pypi + permissions: + id-token: write + steps: + - name: Download artifacts + uses: actions/download-artifact@v4 + with: + name: dist + path: dist/ + + - name: Publish to PyPI + uses: pypa/gh-action-pypi-publish@release/v1 diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..ab1bb4a --- /dev/null +++ b/LICENSE @@ -0,0 +1,190 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to the Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + Copyright 2025 Riley Rice + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/Makefile b/Makefile index 55a3e00..9b21f69 100644 --- a/Makefile +++ b/Makefile @@ -27,10 +27,10 @@ test-v: pytest -v lint: - ruff check src tests + ruff check dotfiles tests format: - ruff format src tests + ruff format dotfiles tests typecheck: mypy @@ -38,5 +38,5 @@ typecheck: check: lint typecheck test clean: - rm -rf build/ dist/ *.egg-info src/*.egg-info .pytest_cache .mypy_cache .ruff_cache + rm -rf build/ dist/ *.egg-info .pytest_cache .mypy_cache .ruff_cache find . -type d -name __pycache__ -exec rm -rf {} + diff --git a/README.md b/README.md index 60809a0..d9d87dc 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,27 @@ # dotfiles -Personal dotfiles for Neovim, Tmux, Zsh, Ghostty, Kitty, i3, and Polybar. +[![PyPI version](https://badge.fury.io/py/dotfiles-installer.svg)](https://pypi.org/project/dotfiles-installer/) +[![CI](https://github.com/riceriley59/dotfiles/actions/workflows/ci.yml/badge.svg)](https://github.com/riceriley59/dotfiles/actions/workflows/ci.yml) +[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) + +A CLI tool to install dotfiles configurations from YAML. Includes personal configs for Neovim, Tmux, Zsh, Ghostty, Kitty, i3, and Polybar. ## Installation +### From PyPI + +```bash +pip install dotfiles-installer + +# macOS +dotfiles configs/mac.yaml + +# Linux +dotfiles configs/linux.yaml +``` + +### From Source + ```bash git clone https://github.com/riceriley59/dotfiles.git cd dotfiles @@ -20,12 +38,13 @@ dotfiles configs/linux.yaml ``` ├── configs/ # YAML configs (mac.yaml, linux.yaml) +├── dotfiles/ # Installer CLI package ├── files/ # Dotfiles to install │ ├── config/ # ~/.config/* (nvim, ghostty, kitty, i3, polybar) │ ├── zsh/ # ~/.zshrc, ~/.zsh_profile │ ├── tmux/ # ~/.tmux.conf │ └── bin/ # ~/.local/scripts -└── src/dotfiles/ # Installer CLI +└── tests/ # Test suite ``` ## What Gets Installed diff --git a/src/dotfiles/__init__.py b/dotfiles/__init__.py similarity index 100% rename from src/dotfiles/__init__.py rename to dotfiles/__init__.py diff --git a/src/dotfiles/cli.py b/dotfiles/cli.py similarity index 100% rename from src/dotfiles/cli.py rename to dotfiles/cli.py diff --git a/src/dotfiles/config.py b/dotfiles/config.py similarity index 100% rename from src/dotfiles/config.py rename to dotfiles/config.py diff --git a/src/dotfiles/installer.py b/dotfiles/installer.py similarity index 100% rename from src/dotfiles/installer.py rename to dotfiles/installer.py diff --git a/pyproject.toml b/pyproject.toml index 38e52cd..12389dd 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -3,15 +3,39 @@ requires = ["hatchling"] build-backend = "hatchling.build" [project] -name = "dotfiles" +name = "dotfiles-installer" version = "1.0.0" description = "A CLI tool to install dotfiles configurations from YAML" readme = "README.md" +license = "Apache-2.0" requires-python = ">=3.10" +authors = [ + { name = "Riley Rice", email = "riceriley59@gmail.com" } +] +keywords = ["dotfiles", "configuration", "cli", "automation", "setup"] +classifiers = [ + "Development Status :: 4 - Beta", + "Environment :: Console", + "Intended Audience :: Developers", + "License :: OSI Approved :: Apache Software License", + "Operating System :: MacOS", + "Operating System :: POSIX :: Linux", + "Programming Language :: Python :: 3", + "Programming Language :: Python :: 3.10", + "Programming Language :: Python :: 3.11", + "Programming Language :: Python :: 3.12", + "Topic :: System :: Installation/Setup", + "Topic :: Utilities", +] dependencies = [ "pyyaml>=6.0", ] +[project.urls] +Homepage = "https://github.com/riceriley59/dotfiles" +Repository = "https://github.com/riceriley59/dotfiles" +Issues = "https://github.com/riceriley59/dotfiles/issues" + [project.optional-dependencies] dev = [ "pytest>=7.0", @@ -24,14 +48,10 @@ dev = [ dotfiles = "dotfiles.cli:main" [tool.hatch.build.targets.wheel] -packages = ["src/dotfiles"] - -[tool.hatch.build.targets.wheel.sources] -"src" = "" +packages = ["dotfiles"] [tool.pytest.ini_options] testpaths = ["tests"] -pythonpath = ["src"] [tool.mypy] python_version = "3.10" @@ -39,12 +59,12 @@ strict = true warn_return_any = true warn_unused_ignores = true disallow_untyped_defs = true -files = ["src/dotfiles", "tests"] +files = ["dotfiles", "tests"] [tool.ruff] target-version = "py310" line-length = 88 -src = ["src", "tests"] +src = ["dotfiles", "tests"] [tool.ruff.lint] select = [ diff --git a/tests/test_config.py b/tests/test_config.py index 2c88136..857112a 100644 --- a/tests/test_config.py +++ b/tests/test_config.py @@ -3,7 +3,6 @@ from pathlib import Path import pytest - from dotfiles.config import expand_path, load_config diff --git a/tests/test_installer.py b/tests/test_installer.py index e220b66..d171bf7 100644 --- a/tests/test_installer.py +++ b/tests/test_installer.py @@ -3,7 +3,6 @@ from pathlib import Path import pytest - from dotfiles.installer import Installer