Rename the logger to dowel

rlworkgroup · May 10, 2019 · 3587b83 · 3587b83
1 parent ff8b0f6
commit 3587b83
Show file tree

Hide file tree

Showing 35 changed files with 1,608 additions and 289 deletions.
diff --git a/.gitignore b/.gitignore
@@ -0,0  1,112 @@
 # 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/
 *.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/
 .coverage
 .coverage.*
 .cache
 nosetests.xml
 coverage.xml
 *.cover
 .hypothesis/
 .pytest_cache/
 
 # Translations
 *.mo
 *.pot
 
 # Django stuff:
 *.log
 local_settings.py
 db.sqlite3
 
 # Flask stuff:
 instance/
 .webassets-cache
 
 # Scrapy stuff:
 .scrapy
 
 # Sphinx documentation
 docs/_build/
 
 # PyBuilder
 target/
 
 # Jupyter Notebook
 .ipynb_checkpoints
 
 # pyenv
 .python-version
 
 # celery beat schedule file
 celerybeat-schedule
 
 # 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/
 
 # Pipenv
 Pipfile
 Pipfile.lock
 
 # dowel-specific stuff below this line
 # Autogenerated Sphinx API documentation
 docs/_apidoc
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -0,0  1,78 @@
 fail_fast: false # set to true to have pre-commit stop running hooks after the first failure.
 repos:
 -   repo: local
     hooks:
     -   id: check-commit-message
         name: Check commit message
         language: script
         entry: scripts/check_commit_message
         stages: [commit-msg]
     -   id: pylint
         name: pylint
         entry: pylint
         args: ['-j 0', '--rcfile=setup.cfg']
         stages: [commit, push]
         language: system
         files: \.py$
 
 -   repo: https://github.com/pre-commit/pre-commit-hooks
     rev: v1.3.0
     # https://github.com/pre-commit/pre-commit-hooks/blob/master/README.md
     stages: [commit, push]
     hooks:
     -   id: check-added-large-files     # Prevent giant files from being committed.
         stages: [commit, push]
     -   id: check-ast                   # Simply check whether files parse as valid python.
         stages: [commit, push]
     -   id: check-byte-order-marker     # Forbid files which have a UTF-8 byte-order marker
         stages: [commit, push]
     -   id: check-docstring-first       # Checks for a common error of placing code before the docstring.
         stages: [commit, push]
     -   id: check-executables-have-shebangs # Checks that non-binary executables have a proper shebang.
         stages: [commit, push]
     -   id: check-json                  # Attempts to load all json files to verify syntax.
         stages: [commit, push]
     -   id: check-merge-conflict        # Check for files that contain merge conflict strings.
         stages: [commit, push]
     -   id: check-symlinks              # Checks for symlinks which do not point to anything.
         stages: [commit, push]
     -   id: check-vcs-permalinks        # Ensures that links to vcs websites are permalinks.
         stages: [commit, push]
     -   id: check-xml                   # Attempts to load all xml files to verify syntax.
         stages: [commit, push]
     -   id: check-yaml                  # Attempts to load all yaml files to verify syntax.
         stages: [commit, push]
     -   id: debug-statements            # Check for debugger imports and py37  breakpoint() calls in python source.
         stages: [commit, push]
     -   id: detect-private-key          # Checks for the existence of private keys.
         stages: [commit, push]
     -   id: double-quote-string-fixer   # This hook replaces double quoted strings with single quoted strings.
         stages: [commit, push]
     -   id: end-of-file-fixer           # Makes sure files end in a newline and only a newline.
         stages: [commit, push]
     -   id: flake8                      # Run flake8 on your python files.
         stages: [commit, push]
     -   id: forbid-new-submodules       # Prevent addition of new git submodules.
         stages: [commit, push]
     -   id: mixed-line-ending           # Replaces or checks mixed line ending.
         stages: [commit, push]
     -   id: pretty-format-json          # Checks that all your JSON files have keys that are sorted and indented.
         stages: [commit, push]
     -   id: trailing-whitespace         # Trims trailing whitespace.
         stages: [commit, push]
 # First pass: check format
 -   repo: https://github.com/pre-commit/mirrors-yapf
     rev: v0.25.0
     hooks:
     -   id: yapf
         name: Check format by yapf
         args: ['-dpr']
         stages: [commit, push]
 # Second pass: format in-place
 -   repo: https://github.com/pre-commit/mirrors-yapf
     rev: v0.25.0
     hooks:
     -   id: yapf
         name: Format in-place by yapf
         args: ['-ipr']
         stages: [commit, push]
diff --git a/.travis.yml b/.travis.yml
@@ -0,0  1,42 @@
 language: python
 
 git:
   depth: false
 
 python:
   - "3.6"
 
 # jobs:
 #   include:
 #     # special deploy stage for tag builds ONLY
 #     - stage: deploy
 #       if: tag IS present
 #       script: skip
 #       after_script: skip
 #       deploy:
 #         provider: pypi
 #         user: "${PYPI_USERNAME}"
 #         password: "${PYPI_PASSWORD}"
 #         on:
 #           tags: true
 
 before_install:
   - pip install --upgrade pip  # some TravisCI images have outdated pip
 
 install:
   - pip install .[dev]
 
 script:
   - scripts/travisci/check_precommit.sh
   - flake8 --version
   - flake8 src
   - flake8 --exclude=src,docs --extend-ignore=D
   - coverage run -m nose2 -c setup.cfg
   - pushd docs && make html && popd
 
 after_script:
   - coverage xml
   - bash <(curl -s https://codecov.io/bash)
 
 notifications:
   email: false
diff --git a/CODEOWNERS b/CODEOWNERS
@@ -0,0  1,2 @@
 # Maintainers at root
 * @rlworkgroup/maintainers
diff --git a/LISCENSE b/LISCENSE
@@ -0,0  1,22 @@
 
 MIT License
 
 Copyright (c) 2019 Reinforcement Learning Working Group
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 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
 furnished to do so, subject to the following conditions:
 
 The above copyright notice and this permission notice shall be included in all
 copies or substantial portions of the Software.
 
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 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.
diff --git a/MANIFEST.in b/MANIFEST.in
@@ -0,0  1,18 @@
 # project metadata
 #
 # NOTE: README.md is required to run setup.py. Failure to include it will
 # create a broken PyPI distribution.
 include LICENSE
 include README.md
 # include CONTRIBUTING.md
 
 # tests
 graft tests
 
 # documentation
 graft docs
 prune docs/_build
 
 # ignored files
 global-exclude *.py[co]
 global-exclude .DS_Store
diff --git a/README.md b/README.md
@@ -0,0  1,3 @@
 # dowel
 
 dowel is a little logger for machine learning research.
diff --git a/docs/Makefile b/docs/Makefile
@@ -0,0  1,19 @@
 # Minimal makefile for Sphinx documentation
 #
 
 # You can set these variables from the command line.
 SPHINXOPTS    =
 SPHINXBUILD   = sphinx-build
 SOURCEDIR     = .
 BUILDDIR      = _build
 
 # Put it first so that "make" without argument is like "make help".
 help:
 	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
 
 .PHONY: help Makefile
 
 # Catch-all target: route all unknown targets to Sphinx using the new
 # "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
 %: Makefile
 	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
Original file line number	Diff line number	Diff line change
		@@ -0,0 1,2 @@
		# Maintainers at root
		* @rlworkgroup/maintainers
Original file line number	Diff line number	Diff line change
		@@ -0,0 1,3 @@
		# dowel

		dowel is a little logger for machine learning research.