semvec/pypi-packages huggingface dataset:
indexgen 0.1.3
A utility CLI to generate a hyperlinked table of contents for your Git repositories, outputting as a navigable Markdown file.

## Hyperlinked Index Markdown / Github Repo Table of Contents Generator

## Description
The Hyperlinked Index MD Generator is a command-line tool designed to create a structured and navigable markdown document that serves as a comprehensive index for your github project directories. This tool generates a clickable markdown index, organizing files and folders in a user-friendly format, which is especially beneficial for large and complex projects.

Motivation for this project: I maintain a repository where I push all my data structure and algorithm problems, as well as my LeetCode practice exercises. I wanted to use a navigable index as my README because I wished to see all the problems I've solved on the main GitHub project page. A hyperlinked table of contents seemed like a good idea, but I couldn't find any robust solution for it. Hence, I created this project.

If you want to use the UI directly, [check this out](https://github.com/aimanfatima/hyperlinked-index-md-generator)

## Features
- Generates a markdown file with a linked index of directories and files.
- Allows exclusion of specified files and directories using patterns.
- Option to specify the output file name.
- Simple and easy-to-use command-line interface.

## Installation

To install the Hyperlinked Index MD Generator and use it, follow these steps:

1. Install the package 

```
    pip install indexgen
```

## Usage

To use the Hyperlinked Index MD Generator, run the following command in your terminal:

```
    indexgen generate [OPTIONS]
```

### Options:
- `-o`, `--output` TEXT: Output markdown file name. If not specified, the output will be printed to the console.
- `-i`, `--ignore` TEXT: Patterns of files or directories to ignore. This option can be repeated to specify multiple patterns.

### Example:
Generate an index for the current directory and output to `index.md`, ignoring all `.log` files:

```
    indexgen generate --output index.md --ignore "*.log"
```

If you want to run this command for a repository located elsewhere

```
    indexgen generate "<location/to/any/git/repo>"
```

And then, simply copy the markdown file contents to you project and push it.

## Contributing
Contributions to the Hyperlinked Index MD Generator are welcome!

## License
This project is licensed under the [GNU GENERAL PUBLIC LICENSE](https://github.com/aimanfatima/hyperlinked-index-md-generator/blob/main/LICENSE).

## Acknowledgments
- Special thanks to [Bootstrap](https://getbootstrap.com/) and [Click](https://click.palletsprojects.com/en/7.x/) for making the UI and CLI functionality straightforward and robust.
modularbuildingpy 0.2.5.2
A python module to create linear or nonlinear numerical models for volumetric modular steel buildings using the finite element method (OpenSeesPy).

|python| |MIT| |black|

.. |python| image:: https://img.shields.io/badge/python-3.11-blue.svg
   :target: https://github.com/mbbatukan/ModularBuildingPy/
   :alt: Python

.. |MIT| image:: https://img.shields.io/badge/License-MIT-yellow.svg
   :target: https://opensource.org/licenses/MIT
   :alt: MIT

.. |black| image:: https://img.shields.io/badge/code%20style-black-000000.svg?style=flat
   :target: https://github.com/psf/black
   :alt: Black

ModularBuildingPy
=================

ModularBuildingPy is a Python module designed to create linear or nonlinear numerical models for volumetric modular steel buildings using the finite element method. It leverages the power of OpenSeesPy, a Python library for the Open System for Earthquake Engineering Simulation (OpenSees).

Features
--------

- **Linear and Nonlinear Models**: Create both linear and nonlinear numerical models based on your specific requirements.
- **Volumetric Modular Steel Buildings**: Specifically designed for creating models of volumetric modular steel buildings.
- **Finite Element Method**: Uses the finite element method for creating numerical models, providing accurate and reliable results.
- **OpenSeesPy Integration**: Fully integrated with OpenSeesPy, allowing for advanced earthquake engineering simulations.

Installation
------------

You can install ModularBuildingPy using pip:

.. code-block:: bash

   pip install modularbuildingpy

Usage
-----

After installing the module, you can import it in your Python scripts as follows:

.. code-block:: python

   import modularbuildingpy as mbp

Code Style
----------

This project uses the `Black <https://black.readthedocs.io/en/stable/>`_ code formatter. To ensure consistency in code style, please run Black on any changes before committing:

.. code-block:: bash

   black .


Contributing
------------

Contributions are welcome! Please read the contributing guidelines first.

License
-------

ModularBuildingPy is licensed under the MIT License. See LICENSE for more information.