semvec/pypi-packages huggingface dataset:
tenorman 0.0.1
Tenorman is a Python package for tenor management.
Requires Python: >=3.9


# mgi.tenormanagement

[Short description of your package]

## Installation

This package is available on PyPI and can be installed using `pip`. The instructions below cover installation in a virtual environment, which is recommended to avoid conflicts with other package versions.

### Prerequisites

Ensure that you have Python 3.x installed on your system. If you need to install Python, download it from [python.org](https://www.python.org/downloads/). 

### Setting Up a Virtual Environment (Optional but Recommended)

A virtual environment allows you to manage dependencies for your project separately from your main Python installation. 

First, install `virtualenv` if it's not already installed:

```bash
pip install virtualenv
```

Create a virtual environment in your project directory:

```bash
virtualenv venv
```

Activate the virtual environment:

On Windows:

```bash
venv\Scripts\activate
```

On macOS and Linux:

```bash
source venv/bin/activate
```

### Installing the Package

After activating the virtual environment, you can install the package using `pip`.

If you have a `requirements.txt` file that lists all the dependencies (which might include the package itself if it's listed on PyPI), run:

```bash
pip install -r requirements.txt
```

Otherwise, install the package directly using:

```bash
pip install mgi-tenormanagement
```

Replace `mgi-tenormanagement` with the actual name of your package on PyPI.

## Usage

Provide detailed examples and usage information for your package here.

## Contributing

Instructions for how other developers can contribute to your package. Include guidelines for submitting issues, pull requests, coding standards, etc.

## License

Specify the license under which your package is released, typically found in a `LICENSE` file at the root of the repository.
Be sure to replace placeholder text like `[Short description of your package]` and `[Provide detailed examples and usage information for your package here.]` with actual content relevant to your package. 
After updating, commit this revised README to your repository to ensure that your users have the latest installation and usage instructions.
citibox-profiling 0.5.0
Citibox profiling tool
Requires Python: >=3.7

# Citibox profiling
Python library to profiling inside Citibox backend team 

## How to use it?
Install via pip and initialize it as soon as possible with the following code:

````python 
from citibox.profiling import Profiling, GoogleConfig, ProfilerServiceGoogle

profiling_config = GoogleConfig(
    service_name="name_of_your_service",
    service_version="core-001",
    project_id="gcp_project_id",
    service_account_json_file="path/to/json_credentials-json",
)

profiling_service = ProfilerServiceGoogle(profiling_config)
profiling = Profiling(profiler_service=profiling_service)
profiling.start()

````

##Step-by-step guide:


1. Import library profiler, config and service implementation:

````python 
from citibox.profiling import Profiling, GoogleConfig, ProfilerServiceGoogle
````
2. Create config for your service
````python 
profiling_config = GoogleConfig(
    service_name="name_of_your_service",
    service_version="core-001",
    project_id="gcp_proyect_id",
    service_account_json_file="path/to/json_credentials-json",
)
````

3. Create the service with the previous configuration and pass it to profiling

````python 
profiling_service = ProfilerServiceGoogle(profiling_config)
profiling = Profiling(profiler_service=profiling_service)
````

4. Start collecting information

````python 
profiling.start()
````

5. Enjoy it

## How to use in django project?

Define config in settings
````python
PROFILING = {
    'ACTIVE': True,
    'SERVICE_NAME': 'app_service',
    'SERVICE_VERSION': 'core-001',
    'PROJECT_ID': 'gcp_project_id',
    'SERVICE_ACCOUNT_JSON_FILE': 'path/to/json_credentials-json',
}
````

Add middleware in config

```python
MIDDLEWARE = [
    'citibox.profiling.contrib.django.ProfilingMiddleware',
]
```