#api #pandas #command-line-tool #swagger-ui #cli

app pandas-cli

PandasCLI is a command-line tool for quickly generating and managing Rust projects with PandasAPI structure. It helps you set up new projects, generate modules, and streamline your development workflow with ease.

3 releases (1 stable)

1.0.0 May 24, 2024
0.1.1 May 21, 2024
0.1.0 May 21, 2024

#1470 in Command line utilities

MIT license

28KB
454 lines

PandasCLI

PandasCLI is a command-line tool designed to help developers quickly generate and manage Rust projects using the PandasAPI structure. It streamlines the setup of new projects, module creation, and other essential tasks to boost your productivity.

Features

  • Create new PandasAPI projects
  • Generate modules with controllers, services, DTOs, schemas, and repositories
  • Automatically set up project structure and dependencies
  • Easy integration with MongoDB
  • Pre-configured Swagger UI for API documentation

Installation

To install PandasCLI, ensure you have Rust and Cargo installed on your system, then run:

cargo install pandas-cli

Usage

Create a New Project

To create a new PandasAPI project, run:

pandas-cli new project-name

This command sets up a new project with the specified name, including all necessary directories and files.

Generate a New Module

To generate a new module within your PandasAPI project, run:

pandas-cli generate module module-name

This command creates a new module with the specified name, including controller, service, DTO, schema, and repository files.

Example

Here's how you can use PandasCLI to create a new project and generate a module:

# Create a new project
pandas-cli new my-awesome-api

# Navigate to the project directory
cd my-awesome-api

# Generate a new module
pandas-cli generate module users

License

PandasCLI is licensed under the MIT License. See the LICENSE file for more details.

Contributing

Contributions are welcome! If you have any suggestions, bug reports, or feature requests, please open an issue or submit a pull request on the GitHub repository.

Contact

For any inquiries, please reach out to Marcus Gomes at viniciusllgomes@gmail.com.

Dependencies

~3.5MB
~62K SLoC