init_project is a CLI tool designed to help developers quickly initialize a project structure with predefined directories and files. It simplifies the process of setting up a new project, ensuring consistency and saving time.
- 🚀Automatically creates a set of predefined directories.
- 🚀Adds specified files within each directory.
- 🚀Allows customization of file extensions.
To install the init_project package, use pip:
pip install init_projectAfter installing, you can use the init_project command to initialize your project structure.
To create the project structure in the current directory with files having a .py extension, run:
init_project . pyTo create the project structure in a specific directory (e.g., /path/to/your/project) with files having a .js extension, run:
init_project /path/to/your/project jsThe tool will create the following directory structure:
/path/to/your/project
│
├── controllers
│ └── __init__.ext
│
├── middlewares
│ └── __init__.ext
│
├── utils
│ └── __init__.ext
│
├── routers
│ └── __init__.ext
│
├── models
│ └── __init__.ext
│
├── configs
│ ├── __init__.ext
│ └── config.ext
│
└── services
└── __init__.ext
Where .ext is the file extension you specified when running the init_project command.
To set up a development environment:
-
Clone the repository:
git clone https://github.com/yourusername/init_project.git cd init_project -
Create and activate a virtual environment (optional but recommended):
python -m venv env source env/bin/activate # On Windows use `env\Scripts\activate`
-
Install the package in editable mode with development dependencies:
pip install -e .
Contributions are welcome! Please fork the repository and submit a pull request for any enhancements or bug fixes.
If you encounter any issues, please report them on the issue tracker.
This project is licensed under the MIT License. See the LICENSE file for details.