Skip to content

Commit 4bb2331

Browse files
CodeWithEmadCodeWithEmad
committed
initial commit
0 parents  commit 4bb2331

34 files changed

+2359
-0
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: Bug report
3+
about: Report a bug in Num2Fa
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
**Bug description**
10+
<!-- A clear and concise description of what the bug is. Don't be afraid to include a lot of context and as much background information as possible. If applicable, add screenshots to help explain your problem. -->
11+
<!-- Also include relevant error logs -->
12+
13+
**How to reproduce**
14+
<!-- Include the FULL, EXACT command that you are running and that is causing an error. Also include the FULL, EXACT command output that you see in the console. THIS IS ESPECIALLY IMPORTANT! Thank you :) -->
15+
16+
**Environment**
17+
<!-- Include your OS (e.g. Mac OS, Ubuntu 18.04...) and the num2fa version that you use, which can be obtained with `num2fa --version`. -->
18+
19+
**Additional context**
20+
<!-- Add any other context about the problem here.-->

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: Feature request
3+
about: Suggest or encourage the addition of a new feature to Num2Fa
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
**Is your feature request related to a problem? Please describe.**
11+
<!-- A clear description of what the problem is. Feel free to include as much background information as possible here. It's important that we understand the deeper motivations behind a feature request in order to provide the best possible solution. Ex. "I'm always frustrated when [...]. This is because at my company we do [...]. This is a business requirement because [...]." -->
12+
13+
**Describe the solution you'd like**
14+
<!-- A clear description of what you want to happen -->
15+
16+
**Describe alternatives you've considered**
17+
<!-- A clear and concise description of any alternative solutions or features you've considered.-->
18+
19+
**Additional context**
20+
<!-- Add any other context or screenshots about the feature request here.-->

‎.github/workflows/release.yml‎

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
# This script can be tested locally with act:
2+
#
3+
# act --secret GITHUB_TOKEN=... --job release
4+
#
5+
# https://github.com/nektos/act/
6+
# To generate a token: https://github.com/settings/tokens (add r/w permissions for "Contents")
7+
name: Release
8+
9+
on:
10+
push:
11+
tags:
12+
- '*'
13+
workflow_dispatch:
14+
15+
jobs:
16+
release:
17+
runs-on: ${{ matrix.os }}
18+
strategy:
19+
matrix:
20+
include:
21+
# https://github.com/actions/runner-images#available-images
22+
- os: ubuntu-20.04
23+
locale: C.UTF-8
24+
env:
25+
LC_ALL: ${{ matrix.locale }}
26+
LANG: ${{ matrix.locale }}
27+
steps:
28+
##### Setup environment
29+
# https://github.com/actions/checkout
30+
- uses: actions/checkout@v3
31+
- name: Set up Python
32+
# https://github.com/actions/setup-python
33+
uses: actions/setup-python@v3
34+
with:
35+
python-version: 3.8
36+
cache: 'pip'
37+
cache-dependency-path: requirements/dev.txt
38+
- name: Upgrade pip and setuptools
39+
# https://pypi.org/project/pip/
40+
# https://pypi.org/project/setuptools/
41+
# https://pypi.org/project/wheel/
42+
run: python -m pip install --upgrade pip setuptools==65.6.3 wheel
43+
- name: Print info about the current python installation
44+
run: make ci-info
45+
- name: Install requirements
46+
run: make bootstrap-dev
47+
- name: Check or download gh utility
48+
run: |
49+
if ! which gh; then
50+
echo "Downloading 'gh' utility"
51+
if [ "$(uname -s)" = "Linux" ]; then
52+
curl -L -o gh.tar.gz https://github.com/cli/cli/releases/download/v2.28.0/gh_2.28.0_linux_amd64.tar.gz
53+
tar xzf gh.tar.gz
54+
mv ./gh_2.28.0_linux_amd64/bin/gh /usr/local/bin/gh
55+
else
56+
curl -L -o gh.zip https://github.com/cli/cli/releases/download/v2.28.0/gh_2.28.0_macOS_amd64.zip
57+
unzip xzf gh.zip
58+
mv ./gh_2.28.0_macOS_amd64/bin/gh /usr/local/bin/gh
59+
fi
60+
which gh
61+
fi
62+
63+
##### Create release on GitHub
64+
- name: Create or update GitHub release
65+
run: scriv github-release --repo=codewithemad/num2fa
66+
env:
67+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
68+

‎.github/workflows/test.yml‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
name: Run tests
2+
3+
on:
4+
push:
5+
branches: [ master, main, nightly ]
6+
pull_request:
7+
branches: [ master, main, nightly ]
8+
9+
jobs:
10+
tests:
11+
runs-on: ubuntu-latest
12+
steps:
13+
- uses: actions/checkout@v3
14+
- name: Set up Python
15+
uses: actions/setup-python@v3
16+
with:
17+
python-version: 3.8
18+
cache: 'pip'
19+
cache-dependency-path: requirements/dev.txt
20+
- name: Upgrade pip
21+
run: python -m pip install --upgrade pip setuptools
22+
- name: Install dependencies
23+
run: pip install -r requirements/dev.txt
24+
- name: Run all tests
25+
run: make test

‎.gitignore‎

Lines changed: 176 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,176 @@
1+
# Created by https://www.toptal.com/developers/gitignore/api/python
2+
# Edit at https://www.toptal.com/developers/gitignore?templates=python
3+
4+
### Python ###
5+
# Byte-compiled / optimized / DLL files
6+
__pycache__/
7+
*.py[cod]
8+
*$py.class
9+
10+
# C extensions
11+
*.so
12+
13+
# Distribution / packaging
14+
.Python
15+
build/
16+
develop-eggs/
17+
dist/
18+
downloads/
19+
eggs/
20+
.eggs/
21+
lib/
22+
lib64/
23+
parts/
24+
sdist/
25+
var/
26+
wheels/
27+
share/python-wheels/
28+
*.egg-info/
29+
.installed.cfg
30+
*.egg
31+
MANIFEST
32+
33+
# PyInstaller
34+
# Usually these files are written by a python script from a template
35+
# before PyInstaller builds the exe, so as to inject date/other infos into it.
36+
*.manifest
37+
*.spec
38+
39+
# Installer logs
40+
pip-log.txt
41+
pip-delete-this-directory.txt
42+
43+
# Unit test / coverage reports
44+
htmlcov/
45+
.tox/
46+
.nox/
47+
.coverage
48+
.coverage.*
49+
.cache
50+
nosetests.xml
51+
coverage.xml
52+
*.cover
53+
*.py,cover
54+
.hypothesis/
55+
.pytest_cache/
56+
cover/
57+
58+
# Translations
59+
*.mo
60+
*.pot
61+
62+
# Django stuff:
63+
*.log
64+
local_settings.py
65+
db.sqlite3
66+
db.sqlite3-journal
67+
68+
# Flask stuff:
69+
instance/
70+
.webassets-cache
71+
72+
# Scrapy stuff:
73+
.scrapy
74+
75+
# Sphinx documentation
76+
docs/_build/
77+
78+
# PyBuilder
79+
.pybuilder/
80+
target/
81+
82+
# Jupyter Notebook
83+
.ipynb_checkpoints
84+
85+
# IPython
86+
profile_default/
87+
ipython_config.py
88+
89+
# pyenv
90+
# For a library or package, you might want to ignore these files since the code is
91+
# intended to run in multiple environments; otherwise, check them in:
92+
# .python-version
93+
94+
# pipenv
95+
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
96+
# However, in case of collaboration, if having platform-specific dependencies or dependencies
97+
# having no cross-platform support, pipenv may install dependencies that don't work, or not
98+
# install all needed dependencies.
99+
#Pipfile.lock
100+
101+
# poetry
102+
# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
103+
# This is especially recommended for binary packages to ensure reproducibility, and is more
104+
# commonly ignored for libraries.
105+
# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
106+
#poetry.lock
107+
108+
# pdm
109+
# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
110+
#pdm.lock
111+
# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
112+
# in version control.
113+
# https://pdm.fming.dev/#use-with-ide
114+
.pdm.toml
115+
116+
# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
117+
__pypackages__/
118+
119+
# Celery stuff
120+
celerybeat-schedule
121+
celerybeat.pid
122+
123+
# SageMath parsed files
124+
*.sage.py
125+
126+
# Environments
127+
.env
128+
.venv
129+
env/
130+
venv/
131+
ENV/
132+
env.bak/
133+
venv.bak/
134+
135+
# Spyder project settings
136+
.spyderproject
137+
.spyproject
138+
139+
# Rope project settings
140+
.ropeproject
141+
142+
# mkdocs documentation
143+
/site
144+
145+
# mypy
146+
.mypy_cache/
147+
.dmypy.json
148+
dmypy.json
149+
150+
# Pyre type checker
151+
.pyre/
152+
153+
# pytype static type analyzer
154+
.pytype/
155+
156+
# Cython debug symbols
157+
cython_debug/
158+
159+
# PyCharm
160+
# JetBrains specific template is maintained in a separate JetBrains.gitignore that can
161+
# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
162+
# and can be added to the global gitignore or merged into this file. For a more nuclear
163+
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
164+
#.idea/
165+
166+
### Python Patch ###
167+
# Poetry local configuration file - https://python-poetry.org/docs/configuration/#local-configuration
168+
poetry.toml
169+
170+
# ruff
171+
.ruff_cache/
172+
173+
# LSP config files
174+
pyrightconfig.json
175+
176+
# End of https://www.toptal.com/developers/gitignore/api/python

‎CHANGELOG.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
2+
<a id='changelog-2.0.0'></a>
3+
## v2.0.1 (2023-12-29)
4+
5+
- Num2Fa was born. (by @CodeWithEmad)

0 commit comments

Comments
 (0)