Table of Contents
-
About The Project
-
Getting Started
- Usage
- License
- Contact
- Acknowledgments
About The Project
Just rewriting Git in python. Why?
Here's why:
Classes
(back to top)
GitRepository
- Description: the repository object
- Attributes:
- worktree: the work tree is the path where the files that are meant to be in version control are
- gitdir: the git directory is the path where git stores its own data. Usually is a child directory of the work tree, called .git
- conf: is an instance of the class ConfigParser, from the external module configparser, used to read and write INI configuration files
GitObject
- Description: base class that abstracts the common features of different object types (e.g., blob, commit, tag or tree)
- Methods:
- init: will be used by the derived class to create a new empty object if needed (optional)
- deserialize: will be used by the derived class to convert the data into an object (mandatory)
- serialize: will be used by the derived class to convert the object into a meaningful representation (mandatory)
(back to top)
Built With
(back to top)
Getting Started
Prerequisites
- Python version 3.10 or higher
Installation
(back to top)
Usage
Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.
Init Command
To initialize a new empty TFT repository, use the following command:
tft init [path]
where [path] is the optional path where the repository will be created. If not provided, the repository will be created in the current directory.
For more examples, please refer to the Documentation
(back to top)
License
(back to top)
Contact
(back to top)
Acknowledgments
A few of helpful link
(back to top)