Skip to main content

VCS inspired by Git.

Project description

🌲 Codetrail: Where Code Goes Hiking

PyPI Python License Built with Sheer Determination

🤔 What's This All About?

Welcome to the learning experience! First things first: Codetrail is not trying to be the next Git. Heck, we're actually using Git as our version control system. We're just crazy enough to build our own distributed version control system from scratch because... why not?

💡 The Mission

We're here to prove that with:

  • A dangerous amount of curiosity
  • Caffeine (lots of it)
  • Sheer, unadulterated determination
  • And perhaps a slight dash of madness

You can build a distributed version control system from the ground up. Is it practical? Probably not. Is it educational? Absolutely! Will it be fun? You bet your last semicolon it will be!

🗺️ Roadmap (Or: How We're Building This Thing)

Phase 1: Baby Steps 🐣

  • Project setup (You're looking at it!)
  • init - Because every journey needs a starting point
  • config - Local config only (we're keeping it simple, folks)
  • add - Teaching codetrail which files to track
  • commit - Making our first memories together

Phase 2: Walking Steadily 🚶

  • status - Finding out what's going on
  • log - A trip down memory lane
  • branch - Because sometimes we need parallel universes
  • checkout - Time travel between branches

Phase 3: Starting to Run 🏃

  • merge - Bringing parallel universes together
  • reset - For when we mess up (it happens)
  • revert - For when we mess up but want to be fancy about fixing it
  • Basic conflict resolution (pray we don't need this)

Future Dreams 💭

  • Remote repository support
  • Push/pull mechanisms
  • Interactive rebase (because we're ambitious)
  • Whatever cool feature you suggest!

🎯 What Makes Codetrail Different?

Unlike other VCS projects that try to compete with Git, we're here to:

  • Learn how Git's magic actually works
  • Break things (intentionally, of course)
  • Fix those things (eventually)
  • Document every "aha!" and "oh no!" moment
  • Share the journey with fellow code adventurers

🚀 Getting Started

# TODO!

🤝 Contributing

Found a bug? That's probably a feature! But if you insist, feel free to:

  1. Fork the repo
  2. Create your feature branch
  3. Commit your changes
  4. Push to the branch
  5. Open a Pull Request
  6. Wait for us to figure out how Pull Requests work in our own system

⚠️ Warning

If you're looking for a production-ready VCS, you might want to stick with Git. If you're looking for an adventure in code that might occasionally explode in your face (in a good way), you're in the right place!


Remember: Every great journey begins with a single commit.

Made with ❤️ and excessive amounts of ☕

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

codetrail-0.1.0.tar.gz (9.5 kB view details)

Uploaded Source

Built Distribution

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

codetrail-0.1.0-py3-none-any.whl (7.9 kB view details)

Uploaded Python 3

File details

Details for the file codetrail-0.1.0.tar.gz.

File metadata

  • Download URL: codetrail-0.1.0.tar.gz
  • Upload date:
  • Size: 9.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.4 CPython/3.12.7 Linux/6.5.0-1025-azure

File hashes

Hashes for codetrail-0.1.0.tar.gz
Algorithm Hash digest
SHA256 fb6fc651b9867a0d58f1fa1559b3126e2d8db91904a168841a1ceeffce0e196a
MD5 6daf4f3d6e6af5679055b64da3a2555b
BLAKE2b-256 e38bb4957b4426def2742ba90f86a090d3c9053c42e67a4a508db2ff72024b52

See more details on using hashes here.

File details

Details for the file codetrail-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: codetrail-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 7.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.4 CPython/3.12.7 Linux/6.5.0-1025-azure

File hashes

Hashes for codetrail-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ba8f6c68eb760281bd80f5512a9c5ca2ea6402498f45d4b66f61686b7fd90cf2
MD5 0bf66c4e4b6e9bb95fa1c8a3678853dc
BLAKE2b-256 66204eef4bac9a080f6d6476bbb7b48de82eb1962966ea343691fa5ecaa2e000

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