Skip to content

Commit

Permalink
docs: modify CHANGELOG.md with initial release notes
Browse files Browse the repository at this point in the history
  • Loading branch information
aifirstd3v committed Jun 19, 2024
1 parent 8dd9694 commit a084edd
Showing 1 changed file with 29 additions and 7 deletions.
36 changes: 29 additions & 7 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,35 @@

## [Unreleased]
### Added
- Initial release of ProjectCreator.
- Function to check if the specified Python version is available.
- Logging for Python version check results.
- Error handling for unavailable Python versions.
- **Project Initialization**: Automates the creation of new Python projects using Poetry.
- **Shell Script**: Basic Create Poetry App script.

# Changelog

## [v1.0.0] - 2024-06-20

### Added
- Enhanced use_python_version function with logging.
- Configured logging to output debug information.
- Improved error handling and messaging for Python version setup.
- **Configuration Parsing**: Parses command-line arguments for project name, package name, Python version, and other configurations.
- **Default Values**: Provides default values for project settings including project name, package name, Python version, virtual environment configuration, description, author name, and email.
- **Template Dependencies**: Supports predefined dependencies based on project templates (e.g., `datascience`, `ai`) loaded from `config.toml`.
- **Interactive Prompts**: Interactive prompts for missing configuration values when not provided via command-line arguments.
- **Email Validation**: Validates the format of the provided author email.
- **Version Cleaning**: Cleans and validates Python version formats.
- **Package Name Conversion**: Converts package names to valid formats by replacing hyphens with underscores.
- **Dependency Version Setting**: Sets dependency versions based on provided Python version and upper version limit.
- **Pyproject.toml Creation**: Generates a `pyproject.toml` file with the specified configurations and dependencies.
- **Project Directory Setup**: Creates the project directory and sets up the initial project structure using `poetry new`.
- **Virtual Environment Configuration**: Configures Poetry to create virtual environments inside the project directory if specified.
- **Python Version Usage**: Ensures the specified Python version is used for the project's virtual environment, with detailed logging for debugging.
- **Dependency Installation**: Installs the project dependencies using Poetry.
- **Virtual Environment Activation**: Activates the virtual environment if `virtualenvs.in-project` is set to `true`.
- **Logging**: Comprehensive logging for debugging and tracing the execution flow, including command outputs and errors.

### Improved
- **Error Handling**: Enhanced error handling for missing or incorrect Python versions, and improved user prompts for better guidance.
- **Code Structure**: Improved code structure for readability and maintainability.

### Fixed
- **Python Version Check**: Fixed issues with detecting and using the correct Python version installed on the system.
- **Template Loading**: Fixed loading and applying template dependencies from `config.toml`.

0 comments on commit a084edd

Please sign in to comment.