diff --git a/README.md b/README.md new file mode 100644 index 0000000..0772d58 --- /dev/null +++ b/README.md @@ -0,0 +1,12 @@ +# ShellLogger + +FILL THIS OUT + +## Getting Started + +```bash +git clone git@internal.gitlab.server:ShellLogger/ShellLogger +cd ShellLogger +python3 -m pip install . +pytest +``` diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..083493d --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,63 @@ +[tool.poetry] +name = "shelllogger" +version = "1.0.0" +license = "" +readme = "README.md" +keywords = ["shell", "logging"] +repository = "https://internal.gitlab.server/ShellLogger/ShellLogger" +description = "A tool for keeping track of Python's interactions with the shell." +documentation = "INSERT URL FOR SPHINX DOCS HERE" +authors = [ + "Josh Braun ", + "David Collins ", + "Jason M. Gates " +] +classifiers = [ + "Development Status :: 3 - Alpha", + "Intended Audience :: Developers", + "Intended Audience :: Information Technology", + "Intended Audience :: System Administrators", + # "Licence :: FILL THIS OUT", UNCOMMENT AFTER ADDING LICENSE + "Natural Language :: English", + "Operating System :: MacOS", + "Operating System :: POSIX", + "Operating System :: UNIX", + "Programming Language :: Python :: 3", + "Programming Language :: Python :: 3 :: Only", + "Programming Language :: Python :: 3.8", + "Topic :: Software Development", + "Topic :: Software Development :: Debuggers", + "Topic :: Software Development :: Documentation", + "Topic :: System :: Logging", + "Topic :: System :: Shells", + "Topic :: System :: System Shells", + # "Typing :: Typed" UNCOMMENT AFTER ADDING TYPE HINTS +] +packages = [ + { include = "shelllogger", from = "src" }, +] +# include = ["CHANGELOG.md"] UNCOMMENT WHEN WE ADD A CHANGELOG + + +[tool.poetry.urls] +CI = "https://internal.gitlab.server/ShellLogger/ShellLogger/-/pipelines" +Issues = "https://internal.gitlab.server/ShellLogger/ShellLogger/-/issues" + + +[tool.poetry.dependencies] +python = "^3.8" + + +[tool.poetry.dev-dependencies] +mock = "^4.0" +pytest = "^6.2" +pytest-cov = "^2.12" +pytest-mock = "^3.6" +sphinx = "^4.0" +sphinx-argparse = "^0.2" +sphinx-rtd-theme = "^0.5" + + +[build-system] +requires = ["poetry-core>=1.0"] +build-backend = "poetry.core.masonry.api" diff --git a/setup.py b/setup.py new file mode 100644 index 0000000..687a493 --- /dev/null +++ b/setup.py @@ -0,0 +1,5 @@ +#!/usr/bin/env python3 +import setuptools + +if __name__ == "__main__": + setuptools.setup() diff --git a/tests/test_ShellLogger.py b/tests/test_ShellLogger.py index 9cd3602..c2e8a2a 100644 --- a/tests/test_ShellLogger.py +++ b/tests/test_ShellLogger.py @@ -5,7 +5,7 @@ import pytest import re from pathlib import Path -from src.shelllogger import ShellLogger, ShellLoggerDecoder +from shelllogger import ShellLogger, ShellLoggerDecoder @pytest.fixture(autouse=True)