Metadata-Version: 2.3
Name: aske
Version: 0.5.1
Summary: Platform Architect Development Framework
License: MIT License
         
         Copyright (c) 2024 ASKE Contributors
         
         Permission is hereby granted, free of charge, to any person obtaining a copy
         of this software and associated documentation files (the "Software"), to deal
         in the Software without restriction, including without limitation the rights
         to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
         copies of the Software, and to permit persons to whom the Software is
         furnished to do so, subject to the following conditions:
         
         The above copyright notice and this permission notice shall be included in all
         copies or substantial portions of the Software.
         
         THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
         IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
         FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
         AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
         LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
         OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
         SOFTWARE.
Keywords: platform,architecture,development,framework
Author: ASKE Team
Requires-Python: >=3.9
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Provides-Extra: dev
Requires-Dist: black ; extra == "dev"
Requires-Dist: click (>=8.0.0)
Requires-Dist: pytest ; extra == "dev"
Requires-Dist: python-dotenv (>=1.0.0)
Requires-Dist: pyyaml (>=6.0)
Project-URL: Homepage, https://github.com/caraveo/aske
Description-Content-Type: text/markdown

# ASKE - Platform Architect Development Framework

ASKE is a command-line tool designed to simplify and accelerate the process of initializing and managing development projects. Initially, ASKE focuses on Python, providing an automated way to set up a Python environment complete with virtual environments, git initialization, and essential project files. This allows developers to focus on coding rather than repetitive setup tasks.

## Why ASKE?

In modern development, setting up a new project can be time-consuming with manual steps for configuration and environment setup. ASKE was created to:

- **Automate Repetitive Tasks:** Quickly initialize a new project with a standardized structure.

- **Boost Productivity:** Reduce setup time so you can concentrate on development.

- **Lay the Foundation for Multi-Framework Support:** While ASKE currently focuses on Python, future versions will support additional frameworks such as Node.js, 
Ruby, Java, Go, and PHP.

## Installation

### Using pip

Install ASKE globally via pip:

```pip install aske```

Using Homebrew

Alternatively, if you prefer Homebrew (note that the Homebrew formula is pending integration into the official Homebrew-core):

```brew tap caraveo/aske && brew install aske```

Usage

To create a new Python project, use the following command:

```aske python project-name```

Available commands:

```aske node project-name```

```aske next project-name```

```aske express project-name```

```aske ruby project-name```

Initialize a projects git repository and add a .gitignore file:

```aske init```


### This command will:
	- Create a new project directory named project-name.
	- Set up a Python virtual environment inside the directory.
	- Generate essential project files (e.g., requirements.txt, .env, and a starter app.py).
	- Initialize a Git repository for version control.

## Future Framework Support

### ASKE is built with extensibility in mind. Planned future enhancements include support for:
	- Ruby: (e.g., Rails, Sinatra)
	- Java: (e.g., Spring Boot)
	- Go: (e.g., Gin, Echo)
	- PHP: (e.g., Laravel)

These additions will make ASKE a versatile initializer for a wide range of development environments.

## Contributing

Contributions are welcome! If you have ideas for improvements or additional features, please fork the repository and submit a pull request. For major changes, feel free to open an issue first to discuss your ideas.

## License

ASKE is released under the MIT License. See the LICENSE file for more details.

