Skip to content

Commit

Permalink
feat: Initial commit
Browse files Browse the repository at this point in the history
- Create from cookiecutter
- Sync local environment
  • Loading branch information
attakei committed Mar 23, 2024
0 parents commit 84d40cd
Show file tree
Hide file tree
Showing 26 changed files with 809 additions and 0 deletions.
29 changes: 29 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# top-most EditorConfig file
root = true

# Unix-style newlines with a newline ending every file
[*]
charset = utf-8
end_of_line = lf
indent_style = space
insert_final_newline = true
trim_trailing_whitespace = false

# Windows files
[*.{bat}]
indent_style = space
indent_size = 4
end_of_line = crlf
charset = sjis

# 2 space indentation
[*.{yml,js,json,rst,html,css,md}]
indent_size = 2

# 4 space indentation
[*.{py,toml}]
indent_size = 4

# Tab indentation (no size specified)
[Makefile,*.{cfg}]
indent_style = tab
3 changes: 3 additions & 0 deletions .github/release-body.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
Release atsphinx-mini18n v0.0.0

- Changelog is https://github.com/atsphinx/mini18n/blob/v0.0.0/CHANGES.rst
70 changes: 70 additions & 0 deletions .github/workflows/main.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
name: 'Run CI jobs'

on:
push:
branches:
- '**'
tags-ignore:
- '**'
pull_request:
workflow_dispatch:

jobs:
lint:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v5
with:
python-version-file: '.python-version'
- name: Lint by pre-commit
run: |
pip install pre-commit
pre-commit run --all-files
source-test:
runs-on: ubuntu-latest
strategy:
matrix:
python-version: ['3.8', '3.9', '3.10', '3.11', '3.12']
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v5
with:
python-version: ${{ matrix.python-version }}
- name: Configure venv
run: |
pip install uv
uv venv
uv pip install -r requirements-dev.lock
- name: Run tests
run: |
source .venv/bin/activate
pytest
doc-test:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v5
with:
python-version-file: '.python-version'
- name: Configure venv
run: |
pip install uv
uv venv
uv pip install -r requirements-dev.lock
- name: Run tests
run: |
source .venv/bin/activate
make -C doc linkcheck dirhtml
build-test:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v5
with:
python-version-file: '.python-version'
- name: Build package
run: |
pip install hatch
hatch build
ls -l dist
87 changes: 87 additions & 0 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,87 @@
name: 'Release new version'

on:
push:
tags:
- 'v*.*.*'

jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v5
with:
python-version-file: '.python-version'
- name: Build package
run: |
pip install hatch
hatch build
ls -l dist
- uses: actions/upload-artifact@v4
with:
name: packages-${{ github.ref_name }}
path: dist/
gh-release:
needs: [build]
runs-on: ubuntu-latest
permissions:
contents: write
steps:
- uses: actions/checkout@v4
- uses: actions/download-artifact@v4
with:
name: packages-${{ github.ref_name }}
path: dist/
- uses: ncipollo/release-action@v1
with:
artifacts: 'dist/*'
bodyFile: '.github/release-body.md'
draft: false
name: Release ${{ github.ref_name }}
tag: ${{ github.ref }}
prerelease: false
publish-pypi:
needs: [build]
runs-on: ubuntu-latest
if: success() && ${{ needs.prepare.outputs.is-release }}
steps:
- uses: actions/download-artifact@v4
with:
name: packages-${{ github.ref_name }}
path: dist/
- name: Publish to PyPI
uses: pypa/gh-action-pypi-publish@release/v1
with:
user: __token__
password: ${{ secrets.PYPI_API_TOKEN }}
deploy-doc:
needs: [build]
runs-on: ubuntu-latest
permissions:
pages: write
id-token: write
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v5
with:
python-version-file: '.python-version'
- name: Configure venv
run: |
pip install uv
uv venv
uv pip install -r requirements-dev.lock
- name: Run tests
run: |
source .venv/bin/activate
make -C doc dirhtml
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: doc/_build/dirhtml
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4
174 changes: 174 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,174 @@
### GIGI version 0.1.0
### command with: python

### Python ###
# 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

# poetry
# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
# This is especially recommended for binary packages to ensure reproducibility, and is more
# commonly ignored for libraries.
# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
#poetry.lock

# pdm
# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
#pdm.lock
# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
# in version control.
# https://pdm.fming.dev/#use-with-ide
.pdm.toml

# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
__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/

# PyCharm
# JetBrains specific template is maintained in a separate JetBrains.gitignore that can
# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
# and can be added to the global gitignore or merged into this file. For a more nuclear
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
#.idea/

### Python Patch ###
# Poetry local configuration file - https://python-poetry.org/docs/configuration/#local-configuration
poetry.toml

# ruff
.ruff_cache/

# LSP config files
pyrightconfig.json
15 changes: 15 additions & 0 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
repos:
- repo: https://github.com/astral-sh/ruff-pre-commit
# Ruff version.
rev: v0.3.0
hooks:
# Run the linter.
- id: ruff
# Run the formatter.
- id: ruff-format
- repo: https://github.com/PyCQA/doc8
rev: v1.0.0
hooks:
- id: doc8
args:
- --max-line-length=119
1 change: 1 addition & 0 deletions .python-version
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
3.8
10 changes: 10 additions & 0 deletions CHANGES.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
===========
Change logs
===========

v0.0.0
======

:date: 2023-05-01

Initial commit.
Loading

0 comments on commit 84d40cd

Please sign in to comment.