Skip to content

Update README #8

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
saketkc merged 2 commits into from
Oct 11, 2025
Merged

Update README #8

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3e74e51
Update README
saketkc Oct 11, 2025
286515a
Update history
saketkc Oct 11, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 10 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,14 +11,22 @@

## Installation

Install from PyPI (recommended):

```bash
pip install vayuayan
```

Install development version from GitHub:

```bash
pip install git+https://github.com/saketkc/vayuayan.git
pip install git+https://github.com/saketlab/vayuayan.git
```

Or install from source:

```bash
git clone https://github.com/saketkc/vayuayan.git
git clone https://github.com/saketlab/vayuayan.git
cd vayuayan
pip install -e .
```
Expand Down
5 changes: 5 additions & 0 deletions docs/history.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,11 @@ History

Release history and changelog for vayuayan.

v0.1.1 (2025-10-11)
------------------

* Updated installation instructions to use PyPI as primary method

v0.1.0 (2025-10-11)
------------------

Expand Down
4 changes: 2 additions & 2 deletions docs/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ A Python package for fetching and analysing air quality data from multiple sourc
:target: https://pypi.org/project/vayuayan/
:alt: Python versions

.. image:: https://img.shields.io/github/license/saketkc/vayuayan.svg
:target: https://github.com/saketkc/vayuayan/blob/master/LICENSE
.. image:: https://img.shields.io/github/license/saketlab/vayuayan.svg
:target: https://github.com/saketlab/vayuayan/blob/master/LICENSE
:alt: License

Overview
Expand Down
12 changes: 9 additions & 3 deletions docs/installation.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Installation
Requirements
------------

vayuayan requires Python 3.7 or higher and the following packages:
vayuayan requires Python 3.9 or higher and the following packages:

- requests>=2.25.0
- pandas>=1.3.0
Expand All @@ -28,11 +28,17 @@ The recommended way to install vayuayan is via pip:
Development Installation
------------------------

If you want to contribute to vayuayan or install the latest development version:
Install the latest development version from GitHub:

.. code-block:: bash

git clone https://github.com/saketkc/vayuayan.git
pip install git+https://github.com/saketlab/vayuayan.git

Or if you want to contribute to vayuayan:

.. code-block:: bash

git clone https://github.com/saketlab/vayuayan.git
cd vayuayan
pip install -e ".[dev]"

Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"

[project]
name = "vayuayan"
version = "0.1.0"
version = "0.1.1"
description = "Package for fetching and analyzing air quality data from multiple sources"
readme = "README.md"
license = "MIT"
Expand Down
Loading