README.md

Simpe & Easy Poetry Project Setup Script 🚀

Are you tired of the cumbersome process of setting up a new Python project with specific requirements? Look no further! Our shell script automates the entire process, making your life as a developer smoother and more efficient. Introducing the Ultimate Poetry Project Setup Script!

The issue this project is trying to address was kind of resolved in the lastest version of Poetry, so I believe it will be helpful to users who are still using current version 1.x. The ultimate goal of this project is to upgrade it into a project creation tool with advanced and diverse features, similar to tools like create-react-app and create-next-app, which even the latest version of Poetry does not provide.

We have developed both shell script and Python versions, but since advanced features will continue to be added only to the Python version, we recommend using the Python version for installation.

Features

Project Initialization

Automated Setup: Simplifies the creation of new Python projects using Poetry, ensuring a consistent and repeatable project structure.
Default Values: Provides sensible default values for project name, package name, Python version, virtual environment configuration, description, author name, and email, allowing for quick setup.

Template Support

Predefined Dependencies: Supports project templates (e.g., datascience, ai) with predefined dependencies loaded from a config.toml file located in the user's home directory.
Custom Template Loading: Allows loading and using custom templates to fit different project requirements.

Interactive and User-Friendly Setup

Interactive Prompts: Prompts the user for project-specific inputs if not provided via command line arguments, ensuring all necessary information is gathered for project setup.
Email Validation: Ensures the provided author email is in a valid format.

Clean Up and Overwrite Handling

Directory Management: Handles existing directories gracefully by prompting the user for confirmation before overwriting, ensuring no accidental data loss or overwrite.

Dependency Installation

Automated Installation: Installs project dependencies using Poetry, ensuring the environment is ready for development without manual intervention.

Why Choose Our Script?

Setting up a Python project with specific requirements can be a hassle. Our script eliminates the guesswork and manual edits, letting you focus on what you do best: coding! Here’s why our script stands out:

Time-Saving: Automates repetitive tasks so you can start coding immediately.
Error-Free Setup: Ensures consistent and correct project configurations every time.
User-Friendly: Designed with developers in mind, it’s simple, intuitive, and effective.
Customizable: Adapts to your project needs, ensuring maximum flexibility.

Prerequisites

Before installing create-poetry-app, ensure you have the following dependencies installed on your system:

Zsh: Version 4.3.9 or newer is required, but we recommend version 5.0.8 or newer. To check if Zsh is installed and see its version, run:
```
zsh --version
```
Python: Ensure Python (version 3.6 or higher) is installed. You can check your Python version with python3 --version.
curl or wget: These tools are used to download the installation script.
- To check if curl is installed, run:
```
curl --version
```
- To check if wget is installed, run:
```
wget --version
```
git: Version 2.4.11 or higher is recommended. To check if git is installed and see its version, run:
```
git --version
```

Basic Installation using installer script

create-poetry-app can be installed by running one of the following commands in your terminal. You can install it via the command-line with either curl, wget, or another similar tool.

Method

Using curl

sh -c "$(curl -fsSL https://raw.githubusercontent.com/aifirstd3v/create-poetry-app/main/install.sh)"

Using wget

sh -c "$(wget -O- https://raw.githubusercontent.com/aifirstd3v/create-poetry-app/main/install.sh)"

Using fetch

sh -c "$(fetch -o - https://raw.githubusercontent.com/aifirstd3v/create-poetry-app/main/install.sh)"

Command-Line Options

The script accepts the following command-line options:

-y : Use default values for all prompts.
-p : Set the project name.
-n : Set the package name.
-v : Set the Python version (supports semver specifiers like ^3.12 or ~3.12).
-u : Set an optional upper Python version limit.
-d : Set the project description.
-a : Set the author name.
-e : Set the author email.
-c : Set the virtual environment configuration (true or false).
-t : Set the template name.
-h : Display this help message.

Examples

Example 1: Using Defaults

To create a new project using default values for all prompts:

create-poetry-app -y

Example 2: Specifying Project Name and Python Version

To create a new project with a specified name and Python version:

create-poetry-app -p my_project -v "^3.12"

Example 3: Full Customization

To create a new project with full customization:

create-poetry-app -p my_project -n my_package -v "^3.12" -u "3.33" -d "My new project" -a "Smith Neo" -e "aifirstd3v@matrix.universe" -c true

Prompted Input

If any required options are not provided via the command line, the script will prompt for them interactively. For example, running the script without the -v option will prompt for the Python version.

Project Templates(Optional): New feature in 1.0.0 🚀

The create_poetry_app.py script supports project templates that allow you to predefine dependencies based on the type of project you are creating. This makes it easier to set up projects with common configurations and dependencies.

Using Templates

You can specify a project template using the -t or --template option when running the script. For example:

python create_poetry_app.py -p my_project -t datascience

If you do not specify a template via the command line, the script will prompt you to enter one during execution.

Configuring Templates with config.toml

The templates and their corresponding dependencies are defined in a config.toml file. This file should be placed in the same directory as create_poetry_app.py.

Here is an example of what your config.toml might look like:

[template.dependency.datascience]
pandas = "^2.2.2"
numpy = ">=1.26.0,<2.0.0"

[template.dependency.ai]
pandas = "^2.2.2"
numpy = ">=1.26.0,<3.0.0"
tensorflow = "^2.4.1"

In this example, two templates are defined: datascience and ai. Each template specifies the dependencies that should be included in the pyproject.toml file for projects using that template.

Adding New Templates

To add a new template, simply edit the config.toml file and add a new section under [template.dependency] with the name of your template. For example:

[template.dependency.web]
flask = "^2.0.0"
requests = "^2.25.1"

Now you can use the web template when creating a new project:

python create_poetry_app.py -p my_web_project -t web

Example

Here is a full example of using a template to create a new project:

Ensure your config.toml includes the desired template:

[template.dependency.datascience]
pandas = "^2.2.2"
numpy = ">=1.26.0,<2.0.0"

Run the script with the -t option:

python create_poetry_app.py -p my_datascience_project -t datascience

The script will automatically include the dependencies specified in the datascience template in the pyproject.toml file of the new project. This feature allows you to quickly and consistently set up projects with common dependencies, saving time and reducing errors.

Adding create-poetry-app to Your Shell Configuration(Optional)

If create-poetry-app was not installed via install.sh, you can manually set it up to make the script easily accessible from anywhere in your terminal. This will allow you to run the script from any directory without needing to specify the full path.

For macOS and Linux Users:

Move the Script to a Directory in Your PATH:

It's common to move scripts to /usr/local/bin so they are in your system's PATH. However, depending on your system configuration, you might use a different directory such as /usr/bin or another location included in your PATH. You can find out the directories in your PATH by running echo $PATH in your terminal.

Here is a command to move the script to /usr/local/bin and make it executable:
```
sudo mv create-poetry-app /usr/local/bin/
sudo chmod +x /usr/local/bin/create-poetry-app
```
If you prefer to use a different directory, replace /usr/local/bin/ with your preferred directory.
Add to Shell Configuration File Manually (Optional):

Depending on your shell, you need to add the directory to your PATH in your shell configuration file. The common files are:
- Bash: ~/.bashrc
- Zsh: ~/.zshrc
(You can modify the configuration file according to your system's environment.)

If you're not sure which shell you are using, you can check by running echo $SHELL in your terminal.
- For Bash users, add the following line to your ~/.bashrc file:
```
echo 'export PATH="/usr/local/bin:$PATH"' >> ~/.bashrc
source ~/.bashrc
```
- For Zsh users, add the following line to your ~/.zshrc file:
```
echo 'export PATH="/usr/local/bin:$PATH"' >> ~/.zshrc
source ~/.zshrc
```
Reload Your Shell Configuration:

After editing the configuration file, you need to reload it to apply the changes:
- For Bash users:
```
source ~/.bashrc
```
- For Zsh users:
```
source ~/.zshrc
```
Run the Script from Anywhere:

Now you can run the create-poetry-app script from any directory by simply typing:
```
create-poetry-app
```

By following these steps, you'll make create-poetry-app easily accessible, streamlining your workflow and allowing you to set up new Poetry projects quickly and efficiently from anywhere in your terminal.

Uninstallation

To uninstall create-poetry-app, you can use the uninstaller.sh script. Follow these steps:

If create-poetry-app is already installed in the $HOME/.create-poetry-app directory, you can run the uninstaller.sh script directly from that directory:

Navigate to the Installation Directory:
```
cd $HOME/.create-poetry-app
```
Make the Script Executable (if not already executable):
```
chmod +x uninstaller.sh
```
Run the Uninstaller Script:
```
./uninstaller.sh
```

OR

Using curl

sh -c "$(curl -fsSL https://raw.githubusercontent.com/aifirstd3v/create-poetry-app/main/uninstaller.sh)"

Using wget

sh -c "$(wget -O- https://raw.githubusercontent.com/aifirstd3v/create-poetry-app/main/uninstaller.sh)"

Using fetch

sh -c "$(fetch -o - https://raw.githubusercontent.com/aifirstd3v/create-poetry-app/main/uninstaller.sh)"

This will remove the create-poetry-app installation and any configurations added during the setup.

Basic Poetry Commands and Tips

Here are some essential Poetry commands to help you manage your Python projects efficiently:

Poetry Command	Explanation
`$ poetry --version`	Show the version of your Poetry installation.
`$ poetry new`	Create a new Poetry project.
`$ poetry init`	Add Poetry to an existing project.
`$ poetry add <package>`	Add a package to `pyproject.toml` and install it.
`$ poetry update`	Update your project's dependencies.
`$ poetry install`	Install the dependencies.
`$ poetry show`	List installed packages.
`$ poetry check`	Validate `pyproject.toml`.
`$ poetry export`	Export `poetry.lock` to other formats.
`$ poetry config --list`	Show the Poetry configuration.
`$ poetry env list`	List the virtual environments of your project.
`$ poetry lock`	Pin the latest version of your dependencies into `poetry.lock`.
`$ poetry lock --no-update`	Refresh the `poetry.lock` file without updating any dependency version.
`$ poetry run <command>`	Execute the given command with Poetry.

You can check out the Poetry CLI documentation to learn more about the commands above and the other commands Poetry offers. You can also run poetry --help to see information right in your terminal!

Important Poetry Configuration Settings

To maximize the efficiency and usability of Poetry, here are some key configuration settings and additional knowledge you should be aware of:

Configuration	Explanation
`virtualenvs.in-project`	Determines whether to create virtual environments within the project directory. Set to `true` to keep the virtual environment in the project folder.
`virtualenvs.path`	Defines the path where virtual environments will be created. By default, this is in a cache directory under your home directory.
`virtualenvs.prefer-active-python`	If set to `true`, uses the currently active Python version to create new virtual environments. Introduced in Poetry 1.2.0.
`virtualenvs.prompt`	Sets the format for the virtual environment prompt. Variables available for formatting include `{project_name}` and `{python_version}`.

Setting Configuration Options

You can set these configuration options using the poetry config command. Here are some examples:

Set virtual environments to be created within the project directory:
```
poetry config virtualenvs.in-project true
```

Set the path for virtual environments:

poetry config virtualenvs.path "/path/to/your/virtualenvs"

Use the currently active Python version for new virtual environments:
```
poetry config virtualenvs.prefer-active-python true
```

Customize the virtual environment prompt:

poetry config virtualenvs.prompt "{project_name}-py{python_version}"

Additional Tips

Environment Variables: Poetry can be configured using environment variables, which can be particularly useful in CI/CD pipelines or when you need temporary settings.
Lock Files: The poetry.lock file is crucial for ensuring consistent environments across different setups. Always commit this file to your version control system.
Dependency Groups: Poetry allows you to manage dependencies in groups (e.g., dev, test). This helps keep your production environment clean and your development environment fully equipped.

By mastering these commands and configuration settings, you can take full advantage of Poetry's powerful features and streamline your Python project management.

Todo

Add support for Poetry 2.0 and maintain backward compatibility
Add more options and input support

Take your Python project setup to the next level. Save time, reduce errors, and get started on your next big idea faster than ever before with our Ultimate Poetry Project Setup Script! 🌟

Feedback & Contributions

We love feedback! If you have any suggestions or improvements, feel free to fork this repository and contribute.

Happy Coding! ✨

Files

README.md

Latest commit

History

README.md

File metadata and controls

README.md

Simpe & Easy Poetry Project Setup Script 🚀

Features

Project Initialization

Template Support

Interactive and User-Friendly Setup

Clean Up and Overwrite Handling

Dependency Installation

Why Choose Our Script?

Prerequisites

Basic Installation using installer script

Method

Using curl

Using wget

Using fetch

Command-Line Options

Examples

Example 1: Using Defaults

Example 2: Specifying Project Name and Python Version

Example 3: Full Customization

Prompted Input

Project Templates(Optional): New feature in 1.0.0 🚀

Using Templates

Configuring Templates with config.toml

Adding New Templates

Example

Adding create-poetry-app to Your Shell Configuration(Optional)

For macOS and Linux Users:

Uninstallation

Using curl

Using wget

Using fetch

Basic Poetry Commands and Tips

Important Poetry Configuration Settings

Setting Configuration Options

Additional Tips

Todo

Feedback & Contributions