Skip to content

Commit 85e5c57

Browse files
thewebscrapingthewebscraping
committed
Beta release.
1 parent c8c1149 commit 85e5c57

30 files changed

+2344
-32
lines changed

‎.editorconfig‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# http://editorconfig.org
2+
3+
root = true
4+
5+
[*]
6+
charset = utf-8
7+
end_of_line = lf
8+
insert_final_newline = true
9+
trim_trailing_whitespace = true
10+
11+
[*.{py,rst,ini}]
12+
indent_style = space
13+
indent_size = 4
14+
15+
[*.{html,css,scss,json,yml,xml}]
16+
indent_style = space
17+
indent_size = 2
18+
19+
[*.md]
20+
trim_trailing_whitespace = false
21+
22+
[Makefile]
23+
indent_style = tab
24+
25+
[default.conf]
26+
indent_style = space
27+
indent_size = 2

‎.flake8‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
[flake8]
2+
max-line-length = 120
3+
# E203 conflicts with PEP8; see https://github.com/psf/black#slices
4+
extend-ignore = E203,F811
5+
6+
# flake8-pytest-style
7+
# PT001:
8+
pytest-fixture-no-parentheses = true
9+
# PT006:
10+
pytest-parametrize-names-type = tuple
11+
# PT007:
12+
pytest-parametrize-values-type = tuple
13+
pytest-parametrize-values-row-type = tuple
14+
# PT023:
15+
pytest-mark-no-parentheses = true
16+
# F401:
17+
per-file-ignores = __init__.py:F401

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
name: Bug report
2+
description: File a bug report for the Gemma Template
3+
title: "[Bug]: "
4+
labels: ["bug"]
5+
body:
6+
7+
- type: markdown
8+
attributes:
9+
value: |
10+
- Write an issue title above.
11+
- Search [open](https://github.com/thewebscraping/gemma-template/issues?q=is%3Aopen) and [closed](https://github.com/thewebscraping/gemma-template/issues?q=is%3Aclosed) issues to ensure it has not already been reported.
12+
13+
- type: input
14+
attributes:
15+
label: TLS Requests version
16+
description: >
17+
Specify the TLS Requests version
18+
placeholder: v0.0.1
19+
validations:
20+
required: true
21+
22+
- type: textarea
23+
attributes:
24+
label: Issue description
25+
description: |
26+
Describe your issue briefly. What doesn't work, and how do you expect it to work instead?
27+
validations:
28+
required: true
29+
30+
- type: textarea
31+
attributes:
32+
label: Steps to reproduce / Code Sample
33+
description: |
34+
List of steps or sample code that reproduces the issue.
35+
validations:
36+
required: true

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
blank_issues_enabled: false

‎.github/ISSUE_TEMPLATE/feature_request.yml‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
name: Feature Request
2+
description: Propose a feature for the Gemma Template
3+
title: "[Feature Request]: "
4+
labels: ["enhancement"]
5+
body:
6+
7+
- type: markdown
8+
attributes:
9+
value: |
10+
- Write a proposal title above.
11+
- Search [open](https://github.com/thewebscraping/gemma-template/issues?q=is%3Aopen) and [closed](https://github.com/thewebscraping/gemma-template/issues?q=is%3Aclosed) proposals to ensure the feature has not already been suggested.
12+
13+
- type: textarea
14+
attributes:
15+
label: Describe the feature / enhancement and how it would improve things
16+
description: |
17+
- Dont overcomplicate
18+
validations:
19+
required: true
20+
21+
- type: textarea
22+
attributes:
23+
label: Describe how your proposal will work, with code and/or pseudo-code
24+
validations:
25+
required: true

‎.github/workflows/ci.yml‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
name: CI
2+
3+
on:
4+
push:
5+
branches: ['master', 'main']
6+
7+
pull_request:
8+
branches: ['master', 'main', 'dev', 'develop']
9+
10+
jobs:
11+
build-on-ubuntu:
12+
runs-on: ubuntu-latest
13+
strategy:
14+
fail-fast: false
15+
max-parallel: 3
16+
matrix:
17+
python-version: ['3.9', '3.10', '3.11']
18+
steps:
19+
- uses: actions/checkout@v4
20+
- name: Set up Python ${{ matrix.python-version }}
21+
uses: actions/setup-python@v4
22+
with:
23+
python-version: ${{ matrix.python-version }}
24+
25+
- name: Install Dependencies, Lint and Tests
26+
run: |
27+
python -m pip install --upgrade pip
28+
python -m pip install -r requirements-dev.txt
29+
python -m black gemma_template
30+
python -m isort gemma_template
31+
python -m flake8 gemma_template

‎.github/workflows/publish.yml‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
name: Upload Python Package
2+
3+
on:
4+
release:
5+
types: [created]
6+
7+
jobs:
8+
deploy:
9+
name: Publish PyPI
10+
runs-on: ubuntu-latest
11+
steps:
12+
- uses: actions/checkout@main
13+
- name: Set up Python 3.9
14+
uses: actions/setup-python@v4
15+
with:
16+
python-version: '3.9'
17+
- name: Build package
18+
run: |
19+
python -m pip install -U pip build setuptools twine
20+
- name: Publish
21+
env:
22+
TWINE_USERNAME: __token__
23+
TWINE_PASSWORD: ${{ secrets.PYPI_API_TOKEN }}
24+
run: |
25+
python setup.py sdist bdist_wheel
26+
twine upload --skip-existing dist/*

‎.gitignore‎

Lines changed: 1 addition & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -94,12 +94,6 @@ ipython_config.py
9494
# install all needed dependencies.
9595
#Pipfile.lock
9696

97-
# UV
98-
# Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
99-
# This is especially recommended for binary packages to ensure reproducibility, and is more
100-
# commonly ignored for libraries.
101-
#uv.lock
102-
10397
# poetry
10498
# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
10599
# This is especially recommended for binary packages to ensure reproducibility, and is more
@@ -165,7 +159,4 @@ cython_debug/
165159
# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
166160
# and can be added to the global gitignore or merged into this file. For a more nuclear
167161
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
168-
#.idea/
169-
170-
# PyPI configuration file
171-
.pypirc
162+
.idea/

‎.pre-commit-config.yaml‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
exclude: '^docs.sh/|scripts/'
2+
default_stages: [commit]
3+
4+
default_language_version:
5+
python: python3.10
6+
7+
repos:
8+
- repo: https://github.com/pre-commit/pre-commit-hooks
9+
rev: v4.5.0
10+
hooks:
11+
- id: trailing-whitespace
12+
- id: end-of-file-fixer
13+
- id: check-json
14+
- id: check-toml
15+
- id: check-xml
16+
- id: check-yaml
17+
- id: debug-statements
18+
- id: check-builtin-literals
19+
- id: check-case-conflict
20+
- id: check-docstring-first
21+
- id: detect-private-key
22+
23+
# run the isort.
24+
- repo: https://github.com/PyCQA/isort
25+
rev: 5.13.2
26+
hooks:
27+
- id: isort
28+
29+
# run the flake8.
30+
- repo: https://github.com/PyCQA/flake8
31+
rev: 7.0.0
32+
hooks:
33+
- id: flake8

‎CHANGELOG.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
Release History
2+
===============
3+
4+
0.0.1 (2024-12-28)
5+
-------------------
6+
- Beta release.

0 commit comments

Comments
 (0)