Skip to main content

A library for managing git repositories in a directory.

Project description

Not Gitmodules


Why not_gitmodules?

  1. not_gitmodules demonstrate how simple and elegant gitmodules should be to those developers who enjoy their lives. 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

  1. IMPORTANT: Create a notgitmodules.yaml file in your project's root directory.
repos:
  # directory: url (ssh or https)

  # Example
  file_reader: https://github.com/Free-Apps-for-All/file_manager_git_module
  1. Let not_gitmodules do the job.
  • Example with Code:

    Pass the path to the initializer function:

    from not_gitmodules import initializer
    
    initializer('/path/to/notgitmodules.yaml')
    
  • 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 the not_gitmodules command 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.3.1.tar.gz (6.1 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.3.1-py3-none-any.whl (7.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: not_gitmodules-0.1.3.1.tar.gz
  • Upload date:
  • Size: 6.1 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.3.1.tar.gz
Algorithm Hash digest
SHA256 aac69e21c2434de7412c6e5f08122148643ed5c723fd81045d9ecdc826b61571
MD5 650e0cf89404a52474d0f7cf60fcf646
BLAKE2b-256 f0f466149d7b2412c85a55a1bf7af6782cbb3dc35e2b525b0ebe335466856161

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for not_gitmodules-0.1.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 85a70ecf4b34aabed12d9cd3060ab562851e6bb6443e0784576dab552fba84e9
MD5 2c77ac939d0e2d2a691fbf0dccb9cd9a
BLAKE2b-256 3839ac5491057c158b98a4e833ff9cc752c5d76917590bbc3a84e3b2516d4185

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