Skip to content

Commit

Permalink
Bring project to packaging standards
Browse files Browse the repository at this point in the history
  • Loading branch information
daskol committed Apr 4, 2023
1 parent 7c24e62 commit 4c0fa99
Show file tree
Hide file tree
Showing 4 changed files with 245 additions and 2 deletions.
156 changes: 156 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,156 @@
# Byte-compiled / optimized / DLL files
__pycache__/
*.py[cod]
*$py.class

# C extensions
*.so

# Distribution / packaging
.Python
build/
develop-eggs/
dist/
downloads/
eggs/
.eggs/
lib/
lib64/
parts/
sdist/
var/
wheels/
share/python-wheels/
*.egg-info/
.installed.cfg
*.egg
MANIFEST

# PyInstaller
# Usually these files are written by a python script from a template
# before PyInstaller builds the exe, so as to inject date/other infos into it.
*.manifest
*.spec

# Installer logs
pip-log.txt
pip-delete-this-directory.txt

# Unit test / coverage reports
htmlcov/
.tox/
.nox/
.coverage
.coverage.*
.cache
nosetests.xml
coverage.xml
*.cover
*.py,cover
.hypothesis/
.pytest_cache/
cover/

# Translations
*.mo
*.pot

# Django stuff:
*.log
local_settings.py
db.sqlite3
db.sqlite3-journal

# Flask stuff:
instance/
.webassets-cache

# Scrapy stuff:
.scrapy

# Sphinx documentation
docs/_build/

# PyBuilder
.pybuilder/
target/

# Jupyter Notebook
.ipynb_checkpoints

# IPython
profile_default/
ipython_config.py

# pyenv
# For a library or package, you might want to ignore these files since the code is
# intended to run in multiple environments; otherwise, check them in:
# .python-version

# pipenv
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
# However, in case of collaboration, if having platform-specific dependencies or dependencies
# having no cross-platform support, pipenv may install dependencies that don't work, or not
# install all needed dependencies.
#Pipfile.lock

# poetry
# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
# This is especially recommended for binary packages to ensure reproducibility, and is more
# commonly ignored for libraries.
# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
#poetry.lock

# pdm
# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
#pdm.lock
# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
# in version control.
# https://pdm.fming.dev/#use-with-ide
.pdm.toml

# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
__pypackages__/

# Celery stuff
celerybeat-schedule
celerybeat.pid

# SageMath parsed files
*.sage.py

# Environments
.env
.venv
env/
venv/
ENV/
env.bak/
venv.bak/

# Spyder project settings
.spyderproject
.spyproject

# Rope project settings
.ropeproject

# mkdocs documentation
/site

# mypy
.mypy_cache/
.dmypy.json
dmypy.json

# Pyre type checker
.pyre/

# pytype static type analyzer
.pytype/

# Cython debug symbols
cython_debug/

# PyCharm
.idea/
34 changes: 34 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# LTest

*Simple forking server for testing with reusable context*

## Usage

**ltest** is extremeply simple forking server based on PyTest for local
testing. The main goal of the project is to preload "fat" libraries like JAX or
TensorFlow in execution context of PyTest. It is written from scratch with
naked Python standard library and, of course, [pytest][1].

It seems that it should be rewritten to use IPython kernel for better coherence
with Jupyter since a lot of machine learning practitioners and researchers use
it for development and testing. So, IPython could reduce possible unexpected
side effects.

#### Starting Server

```shell
ltest -l -m preloaded_pkg -m another.preloaded.pkg
```

#### Run Test on Local Server

```shell
ltest -- --co

#### Run Tests with Arguments on Local Server

```shell
ltest -- -v --tb=full -m slow -- path/to/suite/my_test.py
```

[1]: https://github.com/pytest-dev/pytest.git
5 changes: 3 additions & 2 deletions ltest.py
Original file line number Diff line number Diff line change
Expand Up @@ -132,10 +132,11 @@ def run(host: str, port: int, args: list[str]):
logging.info('testing was successfully completed')


def main(ns: Namespace):
def main():
logging.basicConfig(format='%(asctime)s %(levelname)s %(message)s',
level=logging.INFO)

ns: Namespace = parser.parse_args()
if ns.args and ns.args[0] == '--':
ns.args = ns.args[1:]
if ns.listen:
Expand Down Expand Up @@ -170,4 +171,4 @@ def main(ns: Namespace):


if __name__ == '__main__':
main(parser.parse_args())
main()
52 changes: 52 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
[build-system]
requires = ["setuptools", "setuptools-scm[toml]"]
build-backend = "setuptools.build_meta"

[project]
name = "ltest"
authors = [
{name = "Daniel Bershatsky", email = "[email protected]"},
]
description = "Simple forking server for testing with reusable context."
readme = "README.md"
requires-python = ">=3.8"
keywords = ["testing", "local", "fork", "forking"]
license = {text = "MIT"}
classifiers = [
"Development Status :: 4 - Beta",
"License :: OSI Approved :: MIT License",
"Topic :: Scientific/Engineering",
"Topic :: Scientific/Engineering :: Mathematics",
"Topic :: Scientific/Engineering :: Information Analysis",
"Topic :: Scientific/Engineering :: Artificial Intelligence",
"Intended Audience :: Science/Research",
"Operating System :: OS Independent",
"Programming Language :: Python :: 3",
"Programming Language :: Python :: 3.8",
"Programming Language :: Python :: 3.9",
"Programming Language :: Python :: 3.10",
"Programming Language :: Python :: 3.11",
"Typing :: Typed",
]
dependencies = ["flax", "jax", "optax"]
dynamic = ["version"]

[project.optional-dependencies]
test = ["pytest>=7"]

[project.scripts]
ltest = "ltest:main"

[project.urls]
"Source" = "https://github.com/daskol/ltest.git"

[tool.isort]

[tool.pytest]
header = false
minversion = "7"
addopts = "-ra -q -p no:legacypath -p no:doctest -p no:junitxml -p no:pastebin"
testpaths = []
required_plugins = []

[tool.setuptools_scm]

0 comments on commit 4c0fa99

Please sign in to comment.