Trellomize is a command-line project management tool inspired by Trello. It allows users to manage projects, tasks, and user accounts with a rich command-line interface using rich
. The application includes user authentication, project management, task management, and an admin panel for managing user accounts.
- User authentication (login and registration)
- Project creation and management
- Task creation, assignment, and management within projects
- Comments on tasks
- Admin panel for user management
- Rich CLI interface with
rich
for enhanced user experience - Logging with
loguru
-
Clone the repository:
git clone https://github.com/MohammadMahdi-Sharifbeigy/Trellomize.git cd Trellomize
-
Create and Activate a Virtual Environment:
python -m venv venv source venv/bin/activate # On Windows use `venv\Scripts\activate`
-
Install Dependencies:
pip install -r requirements.txt
-
Run the application:
python main.py
Once the application starts, you will be prompted with options to login, register, or exit. After logging in, you can navigate through the main menu to manage projects, tasks, and your profile.
You can also use command-line arguments for administrative tasks such as creating users and projects:
-
Create a new user:
python manager.py create-user --username <username> --password <password> --is_active <true/false> --email <email>
-
Create a new project:
python manager.py create-project --title <project_title> --start_date <dd/mm/yyyy>
-
Purge all data:
python manager.py purge-data
For more details on available commands, run:
python manager.py --help
To run the tests, execute the following command:
python -m unittest test_manager.py
.
├── main.py # Main entry point of the application
├── manager.py # Contains the UserManager, ProjectManager, and TaskManager classes
├── data.json # JSON file for storing project and task data
├── users.json # JSON file for storing user data
├── app.log # Log file for logging
├── requirements.txt # Project dependencies
├── README.md # This README file
├── LICENSE # License information
├── .gitignore # Git ignore file
└── test.py # Test file for manager.py
bcrypt
for password hashingloguru
for loggingrich
for the command-line interfaceargparse
for command-line argument parsingjson
for data storage and manipulation
This project is licensed under the MIT License. See the LICENSE file for details.
Contributions are welcome! Please fork the repository and create a pull request with your changes.
Note: Ensure that the users.json
and data.json
files are present in the project directory to store user and project data. If these files do not exist, they will be created automatically when the application is run.