Skip to main content

Add your description here

Project description

Projects Organizer

A command-line tool designed to help you organize and document your projects with a consistent structure using Markdown files and YAML frontmatter.

Features

  • Command-Line Interface: Easy-to-use CLI tool for managing projects
  • Structured Project Organization:
    • Each project is contained in its own folder
    • Standardized index.md file for project documentation
    • Support for project images and attachments
  • YAML Frontmatter: Structured metadata for each project
  • Flexible Documentation: Markdown-based project descriptions

Installation

You can install Projects Organizer in two ways:

From PyPI (Recommended)

pip install projects-organizer

From Release

  1. Download the latest wheel file from the releases page
  2. Install using pip:
pip install projects_organizer-*-py3-none-any.whl

Usage

Projects Organizer is built with Typer and provides an intuitive command-line interface. Here are some common commands:

# Show help
projects-organizer --help

# List all projects
projects-organizer list

# List all projects in the specified directory
projects-organizer -d ../my_projects list

# Filter projects
projects-organizer list -f '"coding" in title'

# Show details of a specific project
projects-organizer show MyFirstProject

# Validate all projects with the following schema
projects-organizer validate schema.yaml

Contributing

Contributions are welcome! Please open issues or submit pull requests.

License

This project is licensed under the MIT License.

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

projects_organizer-0.4.0.tar.gz (47.6 kB view details)

Uploaded Source

Built Distribution

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

projects_organizer-0.4.0-py3-none-any.whl (4.4 kB view details)

Uploaded Python 3

File details

Details for the file projects_organizer-0.4.0.tar.gz.

File metadata

  • Download URL: projects_organizer-0.4.0.tar.gz
  • Upload date:
  • Size: 47.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.8.15

File hashes

Hashes for projects_organizer-0.4.0.tar.gz
Algorithm Hash digest
SHA256 b1620061d639b4f9b69cf39de1d1659da61e84a2c0285f74f61fb7c366a60ce4
MD5 2922bccb3f2ed07c02634811678e0a03
BLAKE2b-256 c193a9f52047c2ff1650f92c6ace82022155e66140a4dce266b16f1fcdec39f3

See more details on using hashes here.

File details

Details for the file projects_organizer-0.4.0-py3-none-any.whl.

File metadata

File hashes

Hashes for projects_organizer-0.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 10a2e99897af1d2e51e4d4d62bda3e3a0c70cb1b93a59a6fd26a16f6198cc519
MD5 f0e51b2098b610ae304ba55fffce0066
BLAKE2b-256 a878d54b85bfb0fec6093064c56ca2d6edeedff08d2870efaa3790bc649529a0

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