Skip to main content

A powerful Github CLI tool to simplify your workflow

Project description

UDICTI CLI

Your Community & Github Workflow Toolkit for UDSM Developers

UDICTI-CLI logo

UDICTI CLI is a simple, command-line tool built by and for developers at UDSM. It centralizes community connection, smart Git workflows, and developer analytics—all designed around real club needs and integrated with GitHub.

This CLI is mainly for learning and can help you get started using and building CLI tools

✨ Key Features

  • Seamless GitHub Integration: Securely authenticate and connect to your GitHub account.
  • Community at Your Fingertips: Join the UDICTI community, view onboarded developers, and stay updated.
  • Developer Dashboards: Get a personalized analysis of your GitHub profile and activity.
  • Streamlined Workflows: Effortlessly clone repositories, find contribution opportunities, and create standardized pull requests.
  • Logbook Automation (Upcoming): Fill your practical training reports directly from your Git history.

📦 Installation

udicti-cli is available on PyPI. We highly recommend using a virtual environment.

# Install from PyPI
pip install udicti-cli

# Run the welcome command
udicti welcome

For the latest development version, you can install it directly from the repository:

# Clone the repository
git clone https://github.com/Sirily23/udicti-cli.git

# Navigate to the project directory
cd udicti-cli

# Create and activate a virtual environment
python -m venv venv
source venv/bin/activate

# Install the tool in "editable" mode
pip install -e .

🚀 Quick Start

Run the welcome command to get an overview of the tool:

udicti

⚙️ Commands

Here are some of the core commands to get you started:

Command Description
udicti welcome Displays a friendly welcome message and an overview of the CLI.
udicti github-auth Manages secure authentication with your GitHub account (--login, --logout, --status).
udicti join Join the UDICTI developer community right from your terminal.
udicti show dev Shows the list of developers who are currently onboarded.
udicti dashboard me Displays an analysis of your GitHub profile and recent activity.
udicti gh clone Simplifies cloning UDICTI organization repositories.
udicti gh issue-find Finds open issues in UDICTI repos, with filters for labels like "good first issue" or "help wanted."
udicti gh pr-create Guides you through creating pull requests with UDICTI-standardized templates.
udicti logbook --fill (Upcoming) Fills your practical training report using your Git logs and work history.

🤝 Contributing

We welcome contributions! This is a club project, and we believe it can only get better with your help. Whether it's adding new features, improving a command, or enhancing the documentation, your contribution is valuable.

Using this projects for learning and geting familiar with use if cli tools.

Please see the CONTRIBUTING.md file for more details.

📝 License

This project is licensed under the MIT License.

🙏 Credits

A huge thank you to the entire UDICTI UDSM community for the inspiration and collaboration.

Created with passion by the UDICTI Dev Team.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

udicti_cli-1.0.1.tar.gz (17.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

udicti_cli-1.0.1-py3-none-any.whl (20.2 kB view details)

Uploaded Python 3

File details

Details for the file udicti_cli-1.0.1.tar.gz.

File metadata

  • Download URL: udicti_cli-1.0.1.tar.gz
  • Upload date:
  • Size: 17.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.3

File hashes

Hashes for udicti_cli-1.0.1.tar.gz
Algorithm Hash digest
SHA256 525d4df23641b1394ef912501d41e501302e197dc5f5db1cca21e9e9e1291b38
MD5 1aa29efcb8eb5de4d88033671f2abf13
BLAKE2b-256 9ec14a8102a410309cceae1a93ca5ca8223c0b467094eceb981e66bf30d9a209

See more details on using hashes here.

File details

Details for the file udicti_cli-1.0.1-py3-none-any.whl.

File metadata

  • Download URL: udicti_cli-1.0.1-py3-none-any.whl
  • Upload date:
  • Size: 20.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.3

File hashes

Hashes for udicti_cli-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 9e3e7a3bcd60c60df313292683ffe6da42773dfaa8d28139d7c4a48d671c9d73
MD5 d3a5da670ddd93e78c0f67c041ada1be
BLAKE2b-256 3d569710cf7b3377738e8929cf8c543f49cdb4e132bfbf917ac8d321f56a40b5

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page