Skip to content

Commit

Permalink
Merge pull request #1 from patdaburu/working
Browse files Browse the repository at this point in the history
Working
  • Loading branch information
patdaburu committed Mar 25, 2018
2 parents 0a37770 + 963e1ec commit c975e8e
Show file tree
Hide file tree
Showing 24 changed files with 972 additions and 1 deletion.
12 changes: 12 additions & 0 deletions .coveragerc
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# .coveragerc to control coverage.py
[run]
omit =
*/venv/*
*/tests/*
*/docs/*
*/dist/*
setup.py
scratch*.py

[html]
directory=./docs/build/html/coverage
106 changes: 106 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,106 @@
# Byte-compiled / optimized / DLL files
__pycache__/
*.py[cod]
*$py.class

# C extensions
*.so

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

# 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

# Flask stuff:
instance/
.webassets-cache

# Scrapy stuff:
.scrapy

# Sphinx documentation
docs/_build/
docs/build

# PyBuilder
target/

# Jupyter Notebook
.ipynb_checkpoints

# pyenv
.python-version

# celery beat schedule file
celerybeat-schedule

# SageMath parsed files
*.sage.py

# dotenv
.env

# virtualenv
.venv
venv/
ENV/

# Spyder project settings
.spyderproject
.spyproject

# Rope project settings
.ropeproject

# mkdocs documentation
/site

# mypy
.mypy_cache/

# JetBrains
.idea
9 changes: 9 additions & 0 deletions .readthedocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
build:
image: latest

python:
version: 0.0.1
setup_py_install: true

conda:
file: environment.yml
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2018 patdaburu
Copyright (c) 2018 Pat Daburu

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
62 changes: 62 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
.DEFAULT_GOAL := build
.PHONY: build publish pubtest docs venv conda
PROJ_NAME = evenz
PY_VERSION = 3.6

build:
@echo No python build is defined.

freeze:
pip freeze > requirements.txt

test:
py.test --cov . tests/

coverage: test
mkdir -p docs/build/html
coverage html

docs: coverage
mkdir -p docs/source/_static
mkdir -p docs/source/_templates
cd docs && $(MAKE) html

pubtest: docs
python setup.py sdist

publish: clean docs
python setup.py sdist upload -r pypi

clean :
rm -rf dist \
rm -rf docs/build \
rm -rf *.egg-info
coverage erase

venv :
virtualenv --python python$(PY_VERSION) venv
@echo
@echo To activate the environment, use the following command:
@echo source venv/bin/activate


conda:
conda env create -f environment.yml
@echo
@echo To activate the environment, use the following command:
@echo source activate $(PROJ_NAME)
@echo
@echo To remove this environment, use the following command:
@echo conda remove --name $(PROJ_NAME) --all

activate:
@echo Make cannot do this for you, but you can do one of the following...
@echo
@echo If you are using a local virtual environment:
@echo source venv/bin/activate
@echo
@echo If your are using a conda virtual environment:
@echo source activate $(PROJ_NAME)

install:
pip install -r requirements.txt
2 changes: 2 additions & 0 deletions README
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
evenz
Simple event-driven python.
9 changes: 9 additions & 0 deletions bower.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
{
"name": "evenz",
"authors": ["Pat Daburu <pat@daburu.net>"],
"description": "Simple event-driven python.",
"main": "index.js",
"license": "MIT",
"homepage": "",
"ignore": ["**/.*", "node_modules", "bower_components", "test", "tests"]
}
20 changes: 20 additions & 0 deletions docs/Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Minimal makefile for Sphinx documentation
#

# You can set these variables from the command line.
SPHINXOPTS =
SPHINXBUILD = python -msphinx
SPHINXPROJ = djio
SOURCEDIR = source
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)
36 changes: 36 additions & 0 deletions docs/make.bat
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
@ECHO OFF

pushd %~dp0

REM Command file for Sphinx documentation

if "%SPHINXBUILD%" == "" (
set SPHINXBUILD=python -msphinx
)
set SOURCEDIR=source
set BUILDDIR=build
set SPHINXPROJ=djio

if "%1" == "" goto help

%SPHINXBUILD% >NUL 2>NUL
if errorlevel 9009 (
echo.
echo.The Sphinx module was not found. Make sure you have Sphinx installed,
echo.then set the SPHINXBUILD environment variable to point to the full
echo.path of the 'sphinx-build' executable. Alternatively you may add the
echo.Sphinx directory to PATH.
echo.
echo.If you don't have Sphinx installed, grab it from
echo.http://sphinx-doc.org/
exit /b 1
)

%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
goto end

:help
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%

:end
popd
50 changes: 50 additions & 0 deletions docs/source/_static/images/logo.svg
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
31 changes: 31 additions & 0 deletions docs/source/api.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
.. _api-doc:

.. toctree::
:glob:

.. image:: _static/images/logo.svg
:width: 150px
:alt: evenz
:align: right

API Documentation
=================

-----
evenz
-----
.. automodule:: evenz
:members:
:undoc-members:
:show-inheritance:

------------
evenz.events
------------
.. automodule:: evenz.events
:members:
:undoc-members:
:show-inheritance:



0 comments on commit c975e8e

Please sign in to comment.