Skip to main content

A library for managing git repositories in a directory.

Project description

Not Gitmodules


Why this?

  1. This is how simple gitmodules should be. Add and remove modules without caring about irrelevant stuff. No * shitshow*, just simplicity.
  2. Production-use friendly. This is documented in the license.
  3. No third-party libraries are required; only built-in tools are used.
  4. OS-agnostic. Written in Python, meaning it can be used in any type of project, especially those running on Linux.

Installation

  • Clone the repository using Git.

  • Install via pip:

    pip install not-gitmodules
    

Usage

IMPORTANT: Create a notgitmodules.yaml file in your project's root directory.

  1. Example with Code:

    Create a notgitmodules.yaml file:

    repos:
      # directory: url (ssh or https)
    
      # Example
      file_reader: https://github.com/Free-Apps-for-All/file_manager_git_module
    

    Then pass the path to the initializer function:

    from not_gitmodules import initializer
    
    initializer('/path/to/notgitmodules.yaml')
    
  2. Example with CLI:

    Install the library locally if you cloned the repo:

    pip install .
    

    Once installed, you can delete the local repo from your system (the library is now saved in the virtual environment or globally).

    Run not_gitmodules directly from the terminal:

    not_gitmodules
    

Possible Issues with Private Repositories

If cloning fails but you have access to the repository, provide the HTTPS repo URL instead of SSH in notgitmodules.yaml.


That's it!

No more wasted time with .git, metadata, and other bloat that offer no real tradeoff.


Recommended Modifications

After cloning the repository, delete unnecessary files if you're customizing or using the project for specific purposes:

  • not_gitmodules\.gitignore
  • not_gitmodules\LICENSE
  • not_gitmodules\README.md
  • not_gitmodules\setup.py (if you're not using it as a CLI tool or environment package)
  • not_gitmodules/cli.py (if you're not using the installer in a CLI context)

Author

Armen-Jean Andreasian, 2024


License

This project is licensed under a Custom License. See the LICENSE file for full details.

Key points:

  • You may use this project for commercial or personal purposes.
  • You may not claim ownership of this project or its code.

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

not_gitmodules-0.1.2.tar.gz (5.9 kB view details)

Uploaded Source

Built Distribution

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

not_gitmodules-0.1.2-py3-none-any.whl (7.3 kB view details)

Uploaded Python 3

File details

Details for the file not_gitmodules-0.1.2.tar.gz.

File metadata

  • Download URL: not_gitmodules-0.1.2.tar.gz
  • Upload date:
  • Size: 5.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for not_gitmodules-0.1.2.tar.gz
Algorithm Hash digest
SHA256 33e0eccb949bcc3e0cbf5056e5b9a495d5bce49efd5b908c4e9bf18a1869e181
MD5 bdec98d932327ad5ec20d957d13ee76f
BLAKE2b-256 c590c79db575ae1040cbb85d796f228dc8d87df5d7db78635ac98808c2bdfd74

See more details on using hashes here.

File details

Details for the file not_gitmodules-0.1.2-py3-none-any.whl.

File metadata

  • Download URL: not_gitmodules-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 7.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for not_gitmodules-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 f4cbe327df209db8f854a03cf8fea15cb4e056bfe37500e49f2031f3f7d5b992
MD5 0ba62d8de715da7f6a3b995b59de1205
BLAKE2b-256 350566468657a3530fc3480a94b858f3f542e317ce71287b54e543e8c9f2de04

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