semvec/pypi-packages huggingface dataset:
monitorbot 0.0.1
LLM enhanced, general task runner, web monitor and alerting bot
Requires Python: <4.0,>=3.9
Keywords: python

# monitorbot

[![Release](https://img.shields.io/github/v/release/grynn/monitorbot)](https://img.shields.io/github/v/release/grynn/monitorbot)
[![Build status](https://img.shields.io/github/actions/workflow/status/grynn/monitorbot/main.yml?branch=main)](https://github.com/grynn/monitorbot/actions/workflows/main.yml?query=branch%3Amain)
[![codecov](https://codecov.io/gh/grynn/monitorbot/branch/main/graph/badge.svg)](https://codecov.io/gh/grynn/monitorbot)
[![Commit activity](https://img.shields.io/github/commit-activity/m/grynn/monitorbot)](https://img.shields.io/github/commit-activity/m/grynn/monitorbot)
[![License](https://img.shields.io/github/license/grynn/monitorbot)](https://img.shields.io/github/license/grynn/monitorbot)

LLM enhanced, general task runner, web monitor and alerting bot

- **Github repository**: <https://github.com/grynn/monitorbot/>
- **Documentation** <https://grynn.github.io/monitorbot/>

## Getting started with your project

### 1. Create a New Repository

First, create a repository on GitHub with the same name as this project, and then run the following commands:

```bash
git init -b main
git add .
git commit -m "init commit"
git remote add origin git@github.com:grynn/monitorbot.git
git push -u origin main
```

### 2. Set Up Your Development Environment

Then, install the environment and the pre-commit hooks with

```bash
make install
```

This will also generate your `uv.lock` file

### 3. Run the pre-commit hooks

Initially, the CI/CD pipeline might be failing due to formatting issues. To resolve those run:

```bash
uv run pre-commit run -a
```

### 4. Commit the changes

Lastly, commit the changes made by the two steps above to your repository.

```bash
git add .
git commit -m 'Fix formatting issues'
git push origin main
```

You are now ready to start development on your project!
The CI/CD pipeline will be triggered when you open a pull request, merge to main, or when you create a new release.

To finalize the set-up for publishing to PyPI, see [here](https://fpgmaas.github.io/cookiecutter-uv/features/publishing/#set-up-for-pypi).
For activating the automatic documentation with MkDocs, see [here](https://fpgmaas.github.io/cookiecutter-uv/features/mkdocs/#enabling-the-documentation-on-github).
To enable the code coverage reports, see [here](https://fpgmaas.github.io/cookiecutter-uv/features/codecov/).

## Releasing a new version

- Create an API Token on [PyPI](https://pypi.org/).
- Add the API Token to your projects secrets with the name `PYPI_TOKEN` by visiting [this page](https://github.com/grynn/monitorbot/settings/secrets/actions/new).
- Create a [new release](https://github.com/grynn/monitorbot/releases/new) on Github.
- Create a new tag in the form `*.*.*`.

For more details, see [here](https://fpgmaas.github.io/cookiecutter-uv/features/cicd/#how-to-trigger-a-release).

---

Repository initiated with [fpgmaas/cookiecutter-uv](https://github.com/fpgmaas/cookiecutter-uv).
tw-django-base-library 1.3.0
A library for setting up a django project according to Techwalnut innovations LLP guidelines
Requires Python: >=3.8

# tw-django-base-library

This library will help you speed your development time here at Techwalnut innovations LLP. You will get all the standard formats and conventions required in this library. You can read about the code in the tw-django-reference shared with you.  

---

## Features

- **Standard model**: Covers the base model and default queryset, object managers and mandatory fields required.
1. Base
- **Pre-configured admin**: All the mandatory and necessary configuration for any admin panel are available here 
1. AdminLogging
2. ApplicationLogging
- **Some common utilities**: Common utility function are available here. 
1. APIPaginatorParams

---

## Installation

Install the library via pip:

```bash
pip install tw-django-base-library
```

## Setup
Add the app in your installed app in settings.py

```bash
INSTALLED_APPS = [
    ...,
    'django_base_library',
    ...
]
```

To import the the base models 
```bash
from django_base_library.models import Base
```

To import the default admin classes
```bash
from django_base_library.admin import AdminLogging, ApplicationLogging
```

To import the utilities
```bash
from django_base_library.utilities import APIPaginatorParams
#You can import any class/function from the available classes/functions
```