instant-python 0.0.1__tar.gz

instant_python-0.0.1/.github/FUNDING.yml

@@ -0,0 +1,3 @@
+# These are supported funding model platforms
+
+buy_me_a_coffee: dimanu.py

instant_python-0.0.1/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,33 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+## :writing_hand:  Describe the bug
+
+A clear and concise description of what the bug is.
+
+## :ballot_box_with_check:  Steps To Reproduce
+
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+## :heavy_check_mark: Expected behavior
+
+A clear and concise description of what you expected to happen.
+
+## :camera:  Screenshots
+
+If applicable, add screenshots to help explain your problem.
+
+
+## 🗞️ Additional context
+Add any other context about the problem here.
+

instant_python-0.0.1/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,23 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+## ✍️ Describe your proposal
+
+**Is your feature request related to a problem?**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise 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.

instant_python-0.0.1/.github/actions/python_setup/action.yml

@@ -0,0 +1,20 @@
+name: Install Python and setup environment
+
+inputs:
+  python-version:
+    description: 'The version of Python to use'
+    required: false
+    default: "3.12"
+outputs: {}
+runs:
+  using: composite
+  steps:
+    - uses: actions/setup-python@v5
+      with:
+        python-version: ${{ inputs.python-version }}
+    - name: Install dependency manager
+      run: python -m pip install uv
+      shell: bash
+    - name: Install dependencies
+      run: uv sync --all-groups
+      shell: bash

instant_python-0.0.1/.github/workflows/publish.yml

@@ -0,0 +1,21 @@
+name: Publish Release
+
+on:
+  release:
+    types: [ created ]
+
+jobs:
+  build-and-publish:
+    runs-on: ubuntu-latest
+    environment: release
+    permissions:
+      id-token: write
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+      - name: Set up Python environment
+        uses: ./.github/actions/python_setup
+      - name: Build package
+        run: uv build
+      - name: Publish
+        uses: pypa/gh-action-pypi-publish@release/v1

instant_python-0.0.1/.github/workflows/release.yml

@@ -0,0 +1,43 @@
+name: Generate Release
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  bump-version:
+    if: "!startsWith(github.event.head_commit.message, 'bump:')"
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out
+        uses: actions/checkout@v3
+        with:
+          token: ${{ secrets.CHANGELOG_TOKEN }}
+          fetch-depth: 0
+
+      - name: Bump version and update changelog
+        uses: commitizen-tools/commitizen-action@master
+        with:
+          github_token: ${{ secrets.CHANGELOG_TOKEN }}
+
+  create-release:
+    needs: bump-version
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out
+        uses: actions/checkout@v3
+        with:
+          token: ${{ secrets.CHANGELOG_TOKEN }}
+          fetch-depth: 0
+      - name: Get last tag
+        id: last_tag
+        run: echo "tag=$(git describe --tags --abbrev=0)" >> $GITHUB_OUTPUT
+
+      - name: Create release
+        uses: ncipollo/release-action@v1
+        with:
+          token: ${{ secrets.CHANGELOG_TOKEN }}
+          tag: ${{ steps.last_tag.outputs.tag }}
+          name: Release ${{ steps.last_tag.outputs.tag }}
+          bodyFile: CHANGELOG.md

instant_python-0.0.1/.gitignore

@@ -0,0 +1,141 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+docs/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
+
+# 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-project.org/#use-with-ide
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# 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/

instant_python-0.0.1/.python-version

@@ -0,0 +1 @@
+3.12

instant_python-0.0.1/CHANGELOG.md

@@ -0,0 +1,348 @@
+## 0.12.1 (2025-04-06)
+
+### 🐛 Bug Fixes
+
+- **project-generator**: add template types values to be able to use enum in jinja templates
+- **template**: write correct option when fastapi built in feature is selected
+
+### ♻️ Code Refactoring
+
+- **template**: include mypy, git and pytest configuration files only when the user has selected these options
+- **template**: include dependencies depending on user built in features selection
+
+## 0.12.0 (2025-04-06)
+
+### ✨ Features
+
+- **project-generator**: create new custom function to generate import path in templates
+
+### 🐛 Bug Fixes
+
+- **template**: generate correctly the import statement in templates depending on the user selection
+
+## 0.11.0 (2025-03-24)
+
+## 0.10.4 (2025-03-24)
+
+### 🐛 Bug Fixes
+
+- correct pages workflow
+
+## 0.10.3 (2025-03-24)
+
+### 🐛 Bug Fixes
+
+- correct pages workflow
+
+## 0.10.2 (2025-03-24)
+
+### 🐛 Bug Fixes
+
+- **installer**: correct answers when installing dependencies
+
+## 0.10.1 (2025-03-24)
+
+### 🐛 Bug Fixes
+
+- **prompter**: modify DependenciesQuestion to not enter an infinite loop of asking the user
+
+## 0.10.0 (2025-03-23)
+
+### ✨ Features
+
+- **prompter**: implement general project step that will only be used when custom template is passed
+- **cli**: add template command for project_cli.py to let users create a project using a custom template
+- **prompter**: implement ConditionalQuestion
+- **prompter**: implement TemplateStep to group all questions related to default template management
+- **project-generator**: implement CustomTemplateManager to manage when user passes a custom template file
+- **project-generator**: create TemplateManager interface
+- **cli**: add folder command to allow users to just generate the folder structure of the project
+
+### 🐛 Bug Fixes
+
+- **cli**: temporarily disable template commands
+- **prompter**: extract the value of the base answer to check it with condition
+- **prompter**: remove init argument from year field
+- **cli**: access project_name value when using custom template command
+- **prompter**: set default value for git field in UserRequirements to avoid failing when executing folder command
+- **prompter**: include last question in TemplateStep if selected template is domain_driven_design
+- **project-generator**: instantiate DefaultTemplateManager inside File class
+
+### ♻️ Code Refactoring
+
+- **prompter**: update answers dictionary instead of add manually question key and answer
+- **prompter**: return a dictionary with the key of the question and the answer instead of just the answer
+- **cli**: modify cli help commands and descriptions
+- **prompter**: modify default values for UserRequirements
+- **cli**: use new GeneralCustomTemplateProjectStep in template command
+- **cli**: add name to command and rename command function
+- **prompter**: substitute template and ddd specific questions in TemplateStep for ConditionalQuestion
+- **prompter**: substitute set of question in GitStep for ConditionalQuestion
+- **prompter**: remove should_not_ask method from Step interface
+- **prompter**: remove DomainDrivenDesignStep
+- **cli**: remove DDD step and add TemplateStep
+- **prompter**: remove boilerplate question from DependenciesStep
+- **prompter**: remove template related questions from GeneralProjectStep
+- **prompter**: move git question to GitStep and remove auxiliar continue_git question
+- **cli**: rename function names for better clarity
+- **cli**: move new command to its own typer app
+- **cli**: move folder command to its own typer app and separate the app in two commands
+- **project-generator**: let DefaultTemplateManager implement TemplateManager interface
+- **project-generator**: rename TemplateManager to DefaultTemplateManager
+- **cli**: add template argument to both command to begin allow the user to pass a custom path for the project structure
+- **cli**: add help description to both commands
+- **prompter**: move python and dependency manager from dependencies step to general project step as it's information that is needed in general to fill all files information
+- **cli**: rename generate_project command to new
+
+## 0.9.0 (2025-03-14)
+
+### ✨ Features
+
+- **project-generator**: format all project files with ruff once everything is generated
+- **cli**: remove user_requirements file once project has been generated
+- **prompter**: add remove method to UserRequirements class
+
+### 🐛 Bug Fixes
+
+- **build**: change build system and ensure templates directory gets included
+- **project-generator**: substitute FileSystemLoader for PackageLoader to safer load when using it as a package
+
+### ♻️ Code Refactoring
+
+- **prompter**: add file_path field to user requirements class
+
+## 0.8.1 (2025-03-14)
+
+### 🐛 Bug Fixes
+
+- **prompter**: correct default source folder name
+- **template**: correct license field from pyproject.toml template
+
+### ♻️ Code Refactoring
+
+- **cli**: pass project slug name as the project directory that will be created
+- **project-generator**: pass the directory where the project will be created to FolderTree
+- **cli**: remove checking if a user_requirements file exists
+- **template**: remove writing author and email info only if manager is pdm
+
+## 0.8.0 (2025-03-11)
+
+### ✨ Features
+
+- **cli**: call to git configurer when user wants to initialize a git repository
+- **installer**: implement GitConfigurer
+- **cli**: include git step into cli steps
+- **prompter**: implement step to ask the user information to initialize a git repository
+
+### ♻️ Code Refactoring
+
+- **installer**: avoid printing executed commands output by stdout
+- **template**: use git_email field in pyproject.toml
+- **prompter**: remove email field from UserRequirements and add git_email and git_user_name
+- **prompter**: remove email question from general project step
+
+## 0.7.0 (2025-03-11)
+
+### ✨ Features
+
+- **template**: add clean architecture template project structure
+
+## 0.6.0 (2025-03-11)
+
+### ✨ Features
+
+- **template**: add standard project project structure templates
+
+### ♻️ Code Refactoring
+
+- **project-generator**: remove condition of loading the template only when is domain driven design
+- **template**: use include_and_indent custom macro inside domain_driven_design/test template
+- **template**: include always mypy and pytest ini configuration
+- **prompter**: rename empty project template to standard project
+
+## 0.5.0 (2025-03-10)
+
+### ✨ Features
+
+- **installer**: create factory method to choose which dependency manager gets instantiated
+- **installer**: implement PdmInstaller
+
+### 🐛 Bug Fixes
+
+- **template**: use project_slug for project name inside pyproject.toml
+
+### ♻️ Code Refactoring
+
+- **cli**: use DependencyManagerFactory instead of always instantiating UvManager
+- **installer**: remove ShellConfigurator and ZshConfigurator
+- **cli**: remove shell configurator injection
+- **installer**: remove the use of ShellConfigurator inside installer
+- **prompter**: warn the user that project name cannot contain spaces
+- **prompter**: remove project name question and just leave project slug
+- **installer**: remove executable attribute from UvManager
+
+## 0.4.0 (2025-03-09)
+
+### ✨ Features
+
+- **project-generator**: expose generated project path through ProjectGenerator
+- **installer**: add project_directory field to UvManager to know where to create the virtual environment
+- **installer**: add install_dependencies step to Installer
+- **installer**: implement logic to install dependencies selected by the user in UvManager
+- **installer**: add install_dependencies method to DependencyManger interface
+- **prompter**: implement DependencyQuestion to manage recursive question about what dependencies to install
+- **prompter**: implement DependenciesStep with all questions related to python versions, dependencies etc.
+- **prompter**: implement DomainDrivenDesignStep with bounded context questions.
+- **prompter**: implement GeneralProjectStep that will have common questions such as project name, slug, license etc.
+- **prompter**: implement Steps collection and Step interface
+- **prompter**: implement QuestionWizard to separate questions into steps and be more flexible and dynamic
+- **cli**: install uv by default and python version specified by the user
+- **installer**: implement Installer that will act as the manager class that coordinates all operation required to fully install the project
+- **installer**: implement zsh shell configurator
+- **installer**: create ShellConfigurator interface
+- **installer**: implement UvManager that is in charge of installing uv and the python version required by the user
+- **installer**: add dependency manager interface
+- **installer**: include enums for managers options and operating systems
+- **prompter**: add question to know user's operating system
+- **prompter**: create MultipleChoiceQuestion for questions where the user can select zero, one or more options
+- **prompter**: create BooleanQuestion for yes or no questions
+- **prompter**: create FreeTextQuestion for those questions where the user has to write something
+- **prompter**: create ChoiceQuestion to encapsulate questions that have different options the user needs to choose from
+- **project-generator**: create custom exception when node type does not exist
+- **cli**: make sure user_requirements are loaded
+- **prompter**: add load_from_file method to UserRequirements
+
+### 🐛 Bug Fixes
+
+- **project-generator**: correct path to templates
+
+### ♻️ Code Refactoring
+
+- **installer**: specify working directory to UvManager so it installs everything at the generated project
+- **cli**: pass generated project path to UvManager
+- **installer**: inline uv install command attribute as is not something reusable
+- **cli**: inject folder tree and template manager to project generator
+- **project-generator**: set the directory where user project will be generated as FolderTree attribute and expose it through a property
+- **project-generator**: pass folder_tree and template_manager injected into ProjectGenerator
+- **cli**: pass user dependencies to installer
+- **prompter**: substitute fixed default dependencies by dynamic ones that will be asked to the user
+- **prompter**: remove question definition lists and basic prompter
+- **cli**: substitute BasicPrompter for QuestionWizard
+- **prompter**: remove python manager and operating system questions
+- **prompter**: extract helper method to know if template is ddd
+- **prompter**: delegate ask logic to each question instead of letting prompter what to do depending on flags
+- **prompter**: redefine questions using concrete implementations
+- **prompter**: make Question abstract and add ask abstract method
+- **project-generator**: rename Directory's init attribute to python_module and remove default value for children
+- **project-generator**: move children extraction only when node is a directory
+- **src**: remove old src folder with cookiecutter project and convert current instant_python module into src
+
+## 0.3.0 (2025-03-01)
+
+### ✨ Features
+
+- **template**: include mock event bus template for testing
+- **template**: add scripts templates
+- **prompter**: add fastapi option to built in features
+- **template**: include templates for fasta api application with error handlers, http response modelled with logger
+- **prompter**: add async alembic to built in features options
+- **template**: include templates for async alembic
+- **prompter**: add async sqlalchemy to built in features options
+- **template**: add templates for async sqlalchemy
+- **prompter**: include logger as built in feature
+- **template**: add template for logger
+- **prompter**: include event bus as built in feature
+- **templates**: add project structure template for event bus
+- **templates**: add LICENSE template
+- **prompter**: add year to user requirements fields with automatic computation
+- **templates**: include mypy and pytest init files when default dependencies are selected
+- **templates**: add .python-version template
+- **templates**: add .gitignore template
+- **templates**: add pyproject template
+- **templates**: add makefile template
+
+### ♻️ Code Refactoring
+
+- **cli**: generate user requirements only if no other file has been already generated.
+- **template**: move makefile template to scripts folder as this folder only makes sense if it's use with the makefile
+- **template**: move base from sync sqlalchemy to persistence folder as it would be the same for both sync and async
+- **template**: move sqlalchemy sync templates to specific folder
+- **template**: move exceptions templates to specific folder
+- **template**: move value object templates to specific folder
+- **template**: move github actions templates to specific folder
+- **template**: move logger templates to specific folder
+- **project-generator**: modify File class to be able to manage the difference between the path to the template and the path where the file should be written
+- **template**: change all yml templates to point to inner event_bus folder boilerplate
+- **template**: move all boilerplate related to event bus inside specific folder
+- **prompter**: change github information for basic name and email
+- **prompter**: move default dependencies question to general questions and include the default dependencies that will be included
+- **prompter**: remove converting to snake case all answers and set directly those answers in snake case if needed
+- **templates**: use raw command inside github action instead of make
+
+## 0.2.0 (2025-02-27)
+
+### ✨ Features
+
+- **templates**: add invalid id format error template
+- **templates**: add domain error template
+- **prompter**: add synchronous sqlalchemy option to built in features question
+- **templates**: add synchronous sqlalchemy template
+- **project-generator**: create custom operator to be applied to jinja templates
+- **prompter**: add pre commit option to built in features question
+- **templates**: add pre commit template
+- **prompter**: add makefile option to built in features question
+- **templates**: add makefile template
+- **templates**: separate value objects folder template in a single yml file
+- **templates**: add macro to include files easier and more readable
+- **project-generator**: add TemplateTypes enum to avoid magic strings
+- **prompter**: add question to know which features the user wants to include
+- **prompter**: implement new function to have multiselect questions
+- **prompter**: define all questions in a separate file
+- **prompter**: create Question class to encapsulate questions information
+- **project-generator**: create YamlFile class to create yaml files
+- **project-generator**: create Directory class to create simple folders
+- **templates**: add templates to create github actions and workflows
+- **project-generator**: create NodeType enum to avoid magic strings
+- **templates**: add python files boilerplate
+- **project-generator**: implement logic to create python files with boilerplate content
+- **project-generator**: create specific class to manage jinja templates
+- **prompter**: add save_in_memory method to UserRequirements
+- **project-generator**: implement logic to create python modules
+- **templates**: create DSL to set the folder structure
+- **project-generator**: create classes to model how python files and modules would be created
+- **project-generator**: delegate folder generation to folder tree class
+- **project-generator**: create manager class in charge of creating all project files and folders
+- **prompter**: create class to encapsulate user answers
+- **prompter**: create basic class that asks project requirements to user
+- **cli**: create basic typer application with no implementation
+
+### 🐛 Bug Fixes
+
+- **project-generator**: correct extra blocks that where being created when including templates
+
+### ♻️ Code Refactoring
+
+- **templates**: modify error templates to use DomainError
+- **templates**: change all python-module types to directory and add python flag when need it
+- **project-generator**: make Directory general for any type of folder and remove python module class
+- **project-generator**: remove python_module node type
+- **templates**: set all files of type file and add them the extension variable
+- **project-generator**: add extension field to node and remove deprecated options
+- **project-generator**: create a single node type File that will work with any kind of file
+- **project-generator**: substitute python file and yml file node type for single file
+- **templates**: use new operator to write a single children command in source
+- **project-generator**: include new custom operator in jinja environment
+- **templates**: remove populated shared template
+- **templates**: include value objects template when is specified by the user
+- **templates**: import and call macro inside project structures templates
+- **prompter**: format all answers to snake case
+- use TemplateTypes instead of literal string
+- **project-generator**: change template path name when generating project
+- **templates**: move ddd templates inside project_structure folder
+- **prompter**: migrate BasicPrompter to use questionary instead of typer to make the questions as it manages multiple selections better
+- **cli**: instantiate BasicPrompter instead of using class method
+- **prompter**: simplify ask method by using Question object an iterating over the list of defined questions
+- **templates**: modularize main_structure file
+- **project-generator**: create project structure inside a temporary directory
+- **project-generator**: delegate template management to TemplateManager
+- **cli**: call BasicPrompter and ProjectGenerator inside cli app