Skip to content

Commit acda37d

Browse files
committed
Update .flake8 file, test.yml, README.md, and linting configuration
1 parent 837ed22 commit acda37d

File tree

9 files changed

+316
-221
lines changed

9 files changed

+316
-221
lines changed

.flake8

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
[flake8]
2+
exclude = site-packages, __pycache__, .git, .venv, .eggs, *.egg-info
3+
max-line-length = 88

.github/workflows/tests.yml

Lines changed: 19 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: Tests
1+
name: CI
22

33
on:
44
push:
@@ -15,39 +15,46 @@ jobs:
1515
python-version: ['3.8', '3.9', '3.10', '3.11', '3.12']
1616

1717
steps:
18-
- uses: actions/checkout@v4
19-
18+
- name: Checkout code
19+
uses: actions/checkout@v4
20+
2021
- name: Set up Python ${{ matrix.python-version }}
2122
uses: actions/setup-python@v5
2223
with:
2324
python-version: ${{ matrix.python-version }}
24-
25+
2526
- name: Install dependencies
2627
run: |
2728
python -m pip install --upgrade pip
2829
pip install -e '.[test]'
29-
30-
- name: Run tests
30+
31+
- name: Run tests with pytest
3132
run: |
3233
pytest tests/ -v
3334
3435
lint:
3536
runs-on: ubuntu-latest
3637
steps:
37-
- uses: actions/checkout@v4
38-
38+
- name: Checkout code
39+
uses: actions/checkout@v4
40+
3941
- name: Set up Python
4042
uses: actions/setup-python@v5
4143
with:
4244
python-version: '3.12'
43-
44-
- name: Install dependencies
45+
46+
- name: Install linting dependencies
4547
run: |
4648
python -m pip install --upgrade pip
4749
pip install black isort flake8
48-
50+
51+
- name: Auto-fix formatting issues
52+
run: |
53+
black optimrl tests
54+
isort optimrl tests
55+
4956
- name: Check code formatting
5057
run: |
5158
black --check optimrl tests
5259
isort --check-only optimrl tests
53-
flake8 optimrl tests
60+
flake8 optimrl tests

LICENSE

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
MIT License
2+
3+
Copyright (c) 2025 Subashanan Nair
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is
7+
furnished to do so, subject to the following conditions:
8+
9+
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
10+
11+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
12+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
13+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
14+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
15+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,17 +6,17 @@ OptimRL is a **high-performance reinforcement learning library** that introduces
66
## 🏅 Badges
77

88
![PyPI Version](https://img.shields.io/pypi/v/optimrl)
9-
![PyPI Downloads](https://img.shields.io/pypi/dm/optimrl)
10-
![Python Version](https://img.shields.io/pypi/pyversions/optimrl)
9+
<!-- ![PyPI Downloads](https://img.shields.io/pypi/dm/optimrl) -->
10+
<!-- ![Python Version](https://img.shields.io/pypi/pyversions/optimrl) -->
1111
![Python](https://img.shields.io/badge/Python-3.8%2B-blue?logo=python&logoColor=white)
1212
![C](https://img.shields.io/badge/C-99-00599C?logo=c&logoColor=white)
1313
![NumPy](https://img.shields.io/badge/Library-NumPy-013243?logo=numpy&logoColor=white)
1414
![PyTorch](https://img.shields.io/badge/Framework-PyTorch-EE4C2C?logo=pytorch&logoColor=white)
1515
![Setuptools](https://img.shields.io/badge/Tool-Setuptools-3776AB?logo=python&logoColor=white)
1616
![Build Status](https://github.com/subaashnair/optimrl/actions/workflows/tests.yml/badge.svg)
17-
![CI](https://github.com/subaashnair/optimrl/workflows/CI/badge.svg)
18-
![Coverage](https://img.shields.io/codecov/c/github/subaashnair/optimrl)
19-
![License](https://img.shields.io/github/license/subaashnair/optimrl)
17+
<!-- ![CI](https://github.com/subaashnair/optimrl/workflows/CI/badge.svg) -->
18+
<!-- ![Coverage](https://img.shields.io/codecov/c/github/subaashnair/optimrl) -->
19+
<!-- ![License](https://img.shields.io/github/license/subaashnair/optimrl) -->
2020

2121
## 🌟 Features
2222

optimrl/__init__.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,5 +4,6 @@
44
__all__ = ["GRPO"]
55
from . import _version
66
from ._version import get_versions
7-
__version__ = _version.get_versions()['version']
7+
8+
__version__ = _version.get_versions()["version"]
89
del get_versions

0 commit comments

Comments
 (0)