Skip to content

Commit 6921139

Browse files
init
1 parent 8bd4fea commit 6921139

24 files changed

+943
-1434
lines changed

.github/workflows/test.yaml

+2-2
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ jobs:
1111
strategy:
1212
fail-fast: false
1313
matrix:
14-
python-version: ["3.8", "3.9", "3.10", "3.11"]
14+
python-version: [ "3.11"]
1515
poetry-version: ["1.7"]
1616
# os: [ubuntu-latest, macos-latest, windows-latest]
1717
os: [ubuntu-latest]
@@ -37,7 +37,7 @@ jobs:
3737
run: poetry install
3838

3939
- name: Run tests and generate coverage report
40-
run: poetry run pytest --doctest-modules -v --cov=mppt --cov-fail-under 90 --cov-report=term --cov-report=xml --cov-report=html
40+
run: poetry run pytest --doctest-modules -v --cov=mppt --cov-fail-under 0 --cov-report=term --cov-report=xml --cov-report=html
4141

4242
- name: Upload coverage to Codecov
4343
uses: codecov/codecov-action@v3

CHANGELOG.md

-33
Original file line numberDiff line numberDiff line change
@@ -3,36 +3,3 @@
33

44
## [Unreleased]
55

6-
### Added
7-
- Add Locust as a load testing tool (#39)
8-
- Add package management tool uv (#49)
9-
- Add task runner just (#50)
10-
11-
## [0.3.0] - 2023-12-14
12-
13-
### Added
14-
- Add ruff as extra linter and formatter: both in dependency and pre-commit (#31)
15-
- Add more details about the linters and formatters with the resource from Google SRE book
16-
- Add doctest (#34)
17-
18-
## [0.2.0] - 2023-12-01
19-
20-
### Added
21-
- Documentations for all the features (#20)
22-
- Quick sort implementation for hypothesis testing (#22)
23-
24-
### Changed
25-
- Change package management from Rye to Poetry (#15, #19)
26-
27-
### Removed
28-
- Sweep AI App
29-
30-
## [0.1.1] - 2023-08-15
31-
32-
### Changed
33-
- reorg this package template
34-
35-
## [0.1.0] - 2023-08-15
36-
37-
### Added
38-
- add this package template

LICENSE

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
MIT License
22

3-
Copyright (c) 2023 Mathew Shen
3+
Copyright (c) 2024 Mathew Shen
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

README.md

+3-74
Original file line numberDiff line numberDiff line change
@@ -1,76 +1,5 @@
1-
<p align="center" style="font-size:80px; margin:0px 10px 0px 10px">
2-
<em>MPPT</em>
3-
</p>
4-
<p align="center", style="font-size: 40px">
5-
<em>A Modern Python Package Template
6-
</em>
7-
</p>
1+
# Toy LLM
82

9-
<center>
3+
ToyLLM is a simple language model that can be used to generate text.
4+
It is based on the [GPT-2](https://huggingface.co/transformers/model_doc/gpt2.html) model.
105

11-
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
12-
[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
13-
[![Imports: isort](https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336)](https://pycqa.github.io/isort/)
14-
[![Checked with mypy](https://www.mypy-lang.org/static/mypy_badge.svg)](https://mypy-lang.org/)
15-
[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit)](https://github.com/pre-commit/pre-commit)
16-
[![Build Docs](https://github.com/shenxiangzhuang/mppt/actions/workflows/build_docs.yaml/badge.svg)](https://github.com/shenxiangzhuang/mppt/actions/workflows/build_docs.yaml)
17-
![Test](https://github.com/shenxiangzhuang/mppt/actions/workflows/test.yaml/badge.svg)
18-
![Codecov](https://codecov.io/gh/shenxiangzhuang/mppt/branch/master/graph/badge.svg)
19-
[![Python](https://img.shields.io/badge/Python-3.8,%203.9,%203.10,%203.11-blue)]()
20-
[![PyPI](https://img.shields.io/pypi/v/mppt)](https://pypi.org/project/mppt/)
21-
![GitHub License](https://img.shields.io/github/license/shenxiangzhuang/mppt)
22-
23-
</center>
24-
25-
# About
26-
[MPPT](https://github.com/shenxiangzhuang/mppt): A **M**odern **P**ython **P**ackage **T**emplate.
27-
28-
# Documentation
29-
30-
[https://datahonor.com/mppt/](https://datahonor.com/mppt/)
31-
32-
# Features
33-
- Package Management: Poetry
34-
- Documentation: Mkdocs with Material theme
35-
- Linters&Formatters: Black, Isort, Flake8, Ruff, Mypy, Pre-commit, SonarLint
36-
- Testing: Pytest, Hypothesis, Codecov
37-
- Task runner: Makefile, Duty, Taskfile
38-
- Miscellaneous: Changelog, License, Semantic Versioning, Contributing
39-
40-
41-
## Package Management
42-
- Poetry
43-
44-
## Documentation
45-
46-
- Mkdocs with Material theme
47-
48-
## Linters
49-
50-
- Black
51-
- Isort
52-
- Flake8
53-
- Mypy
54-
- SonarLint
55-
- Pre-commit
56-
57-
58-
## Testing
59-
60-
- Pytest: pytest, pytest-cov, pytest-sugar
61-
- Hypothesis
62-
- Codecov
63-
64-
## Task runner
65-
66-
- Makefile
67-
- Duty
68-
- Taskfile
69-
70-
## Miscellaneous
71-
72-
- Change Log: [Keep a Changelog](https://keepachangelog.com/en/1.1.0/)
73-
- Versioning: [Semantic Versioning](https://semver.org/)
74-
- License: [Choose an open source license](https://choosealicense.com/)
75-
- Badge: [Shields.io](https://shields.io/)
76-
- Contributing: [Contributing to Open Source on GitHub](https://guides.github.com/activities/contributing-to-open-source/)

docs/doc/index.md

-44
This file was deleted.

docs/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
--8<-- "https://raw.githubusercontent.com/shenxiangzhuang/mppt/master/README.md"
1+
--8<-- "https://raw.githubusercontent.com/toy-ai/toyllm/master/README.md"

docs/linter/image/linters.png

-77 KB
Binary file not shown.

0 commit comments

Comments
 (0)