Skip to content

Commit

Permalink
Add installation files
Browse files Browse the repository at this point in the history
  • Loading branch information
jmgate committed Aug 18, 2021
1 parent 04d5b91 commit 0ec0ce4
Show file tree
Hide file tree
Showing 4 changed files with 81 additions and 1 deletion.
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -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
```
63 changes: 63 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -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 <josbrau@sandia.gov>",
"David Collins <dcollin@sandia.gov>",
"Jason M. Gates <jmgate@sandia.gov>"
]
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"
5 changes: 5 additions & 0 deletions setup.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
#!/usr/bin/env python3
import setuptools

if __name__ == "__main__":
setuptools.setup()
2 changes: 1 addition & 1 deletion tests/test_ShellLogger.py
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down

0 comments on commit 0ec0ce4

Please sign in to comment.