initial commit

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,20 @@
+---
+name: Bug report
+about: Report a bug in Num2Fa
+title: ''
+labels: ''
+assignees: ''
+
+---
+**Bug description**
+<!-- 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. -->
+<!-- Also include relevant error logs -->
+
+**How to reproduce**
+<!-- 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 :) -->
+
+**Environment**
+<!-- Include your OS (e.g. Mac OS, Ubuntu 18.04...) and the num2fa version that you use, which can be obtained with `num2fa --version`. -->
+
+**Additional context**
+<!-- Add any other context about the problem here.-->

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest or encourage the addition of a new feature to Num2Fa
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+<!-- 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 [...]." -->
+
+**Describe the solution you'd like**
+<!-- A clear description of what you want to happen -->
+
+**Describe alternatives you've considered**
+<!-- A clear and concise description of any alternative solutions or features you've considered.-->
+
+**Additional context**
+<!-- Add any other context or screenshots about the feature request here.-->

.github/workflows/release.yml

@@ -0,0 +1,68 @@
+# This script can be tested locally with act:
+#
+#    act --secret GITHUB_TOKEN=... --job release
+#
+# https://github.com/nektos/act/
+# To generate a token: https://github.com/settings/tokens (add r/w permissions for "Contents")
+name: Release
+
+on:
+  push:
+    tags:
+      - '*'
+  workflow_dispatch:
+
+jobs:
+  release:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        include:
+          # https://github.com/actions/runner-images#available-images
+          - os: ubuntu-20.04
+            locale: C.UTF-8
+    env:
+      LC_ALL: ${{ matrix.locale }}
+      LANG: ${{ matrix.locale }}
+    steps:
+      ##### Setup environment
+      # https://github.com/actions/checkout
+      - uses: actions/checkout@v3
+      - name: Set up Python
+        # https://github.com/actions/setup-python
+        uses: actions/setup-python@v3
+        with:
+          python-version: 3.8
+          cache: 'pip'
+          cache-dependency-path: requirements/dev.txt
+      - name: Upgrade pip and setuptools
+        # https://pypi.org/project/pip/
+        # https://pypi.org/project/setuptools/
+        # https://pypi.org/project/wheel/
+        run: python -m pip install --upgrade pip setuptools==65.6.3 wheel
+      - name: Print info about the current python installation
+        run: make ci-info
+      - name: Install requirements
+        run: make bootstrap-dev
+      - name: Check or download gh utility
+        run: |
+          if ! which gh; then
+            echo "Downloading 'gh' utility"
+            if [ "$(uname -s)" = "Linux" ]; then
+              curl -L -o gh.tar.gz https://github.com/cli/cli/releases/download/v2.28.0/gh_2.28.0_linux_amd64.tar.gz
+              tar xzf gh.tar.gz
+              mv ./gh_2.28.0_linux_amd64/bin/gh /usr/local/bin/gh
+            else
+              curl -L -o gh.zip https://github.com/cli/cli/releases/download/v2.28.0/gh_2.28.0_macOS_amd64.zip
+              unzip xzf gh.zip
+              mv ./gh_2.28.0_macOS_amd64/bin/gh /usr/local/bin/gh
+            fi
+            which gh
+          fi
+
+      ##### Create release on GitHub
+      - name: Create or update GitHub release
+        run: scriv github-release --repo=codewithemad/num2fa
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+

.github/workflows/test.yml

@@ -0,0 +1,25 @@
+name: Run tests
+
+on:
+  push:
+    branches: [ master, main, nightly ]
+  pull_request:
+    branches: [ master, main, nightly ]
+
+jobs:
+  tests:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Python
+        uses: actions/setup-python@v3
+        with:
+          python-version: 3.8
+          cache: 'pip'
+          cache-dependency-path: requirements/dev.txt
+      - name: Upgrade pip
+        run: python -m pip install --upgrade pip setuptools
+      - name: Install dependencies
+        run: pip install -r requirements/dev.txt
+      - name: Run all tests
+        run: make test

.gitignore

@@ -0,0 +1,176 @@
+# Created by https://www.toptal.com/developers/gitignore/api/python
+# Edit at https://www.toptal.com/developers/gitignore?templates=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
+
+# End of https://www.toptal.com/developers/gitignore/api/python

CHANGELOG.md

@@ -0,0 +1,5 @@
+
+<a id='changelog-2.0.0'></a>
+## v2.0.1 (2023-12-29)
+
+- Num2Fa was born. (by @CodeWithEmad)