semvec/pypi-packages huggingface dataset:
storyweaver 0.1.0
Sets up React with Storybook for component-driven development, including a FastAPI server to mock API responses from user-generated JSON files. Automates Storybook configuration, story generation, and optional mock server startup.
License: MIT
Requires Python: <4.0,>=3.10

# StoryWeaver

## Overview
StoryWeaver sets up a React environment with Storybook for component-driven development and testing. It includes an integrated FastAPI server to mock API responses using user-generated JSON files. The setup script automates Storybook configuration, story generation for React components, and optional FastAPI mock server startup, enhancing the development workflow.

## Features
- **Storybook Integration**: Automatically configures Storybook for your React project.
- **Story Generation**: Generates story files for each React component.
- **API Mocking**: Uses FastAPI to mock API responses from user-provided JSON files.

## Installation

1. **Clone the Repository**

   ```bash
   git clone https://github.com/yourusername/storyweaver.git
   cd storyweaver
   ```

2. **Install Dependencies**

   Using [Poetry](https://python-poetry.org/):

   ```bash
   poetry install
   ```

3. **Initialize Your React Project**

   If you haven't already, set up your React project and install Storybook:

   ```bash
   npx create-react-app my-project
   cd my-project
   npx sb init
   ```

## Usage

1. **Setup Storybook and Generate Stories**

   ```bash
   poetry run python setup_storybook.py path/to/components
   ```

2. **Optionally, Start the FastAPI Mock Server**

   ```bash
   poetry run python setup_storybook.py path/to/components --mock
   ```

3. **Run Storybook**

   ```bash
   npm run storybook
   ```

## Project Structure

- **setup_storybook.py**: Script to configure Storybook and generate stories.
- **mock_api.py**: FastAPI server script to mock API responses.
- **mock_api**: Directory containing user-generated JSON files for API responses.

<!-- ## Example

Here's an example of how you might structure your project:

```
my-project/
│
├── src/
│   ├── components/
│   │   ├── Button.js
│   │   └── Header.js
│   └── ...
├── .storybook/
│   ├── main.js
│   └── preview.js
├── mock_api/
│   ├── users.json
│   └── products.json
├── setup_storybook.py
├── mock_api.py
└── ...
``` -->

## Contributing

Contributions are welcome! Please open an issue or submit a pull request with your changes.

## License

This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
obsaq 0.0.0
A Python package for accessing observational air quality data
License: MIT

ObsAQ: A Python package for accessing observational air quality data
--------------------------------------------------------------------
|DOI| |docs| |GitHub| |license|

.. |DOI| image:: https://zenodo.org/badge/805810422.svg
   :target: https://zenodo.org/doi/10.5281/zenodo.11391797

.. |GitHub| image:: https://img.shields.io/badge/GitHub-obsaq-brightgreen.svg
   :target: https://github.com/envdes/obsaq/ 

.. |Docs| image:: https://img.shields.io/badge/docs-obsaq-brightgreen.svg
   :target: https://envdes.github.io/obsaq/

.. |license| image:: https://img.shields.io/badge/License-MIT-blue.svg
   :target: https://github.com/envdes/obsaq/blob/main/LICENSE

Contributors: `Haofan Wang <https://github.com/Airwhf/>`_, `Zhiyi Song <https://github.com/onebravekid>`_, `David Topping <https://research.manchester.ac.uk/en/persons/david.topping>`_, `Zhonghua Zheng <https://zhonghua-zheng.github.io/>`_ (zhonghua.zheng@manchester.ac.uk)

Installation
------------
Step 1: create an environment::

    $ conda create -n obsaq python=3.11

    $ conda activate obsaq

    $ conda install -c conda-forge numpy pandas pyreadr

Step 2: install using pip::

    $ pip install obsaq

(optional) install from source:: 

    $ git clone https://github.com/envdes/obsaq
    $ cd obsaq
    $ python setup.py obsaq

How to use it?
--------------
Python

Please check the `Tutorial <https://github.com/Airwhf/>`_ for information.

How to ask for help
-------------------
The `GitHub issue tracker <https://github.com/envdes/obsaq/issues>`_ is the primary place for bug reports.