Skip to content

Commit

Permalink
config files added and edited, README.md documentation complete for t…
Browse files Browse the repository at this point in the history
…his stage
  • Loading branch information
thePortus committed Mar 3, 2018
1 parent 920b086 commit ec825d4
Show file tree
Hide file tree
Showing 14 changed files with 783 additions and 113 deletions.
39 changes: 39 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# EditorConfig is awesome: http://EditorConfig.org

# Howto with your editor:
# Sublime: https://github.com/sindresorhus/editorconfig-sublime

# top-most EditorConfig file
root = true

# Unix-style newlines with a newline ending every file
[**]
end_of_line = lf
insert_final_newline = true

# Standard at: https://github.com/felixge/node-style-guide
[**.js, **.json]
trim_trailing_whitespace = true
indent_style = tab
quote_type = single
curly_bracket_next_line = false
spaces_around_operators = true
space_after_control_statements = true
space_after_anonymous_functions = false
spaces_in_brackets = false

indent_size = 4
insert_final_newline = true

# No Standard. Please document a standard if different from .js
[**.yml, **.html, **.css]
trim_trailing_whitespace = true
indent_style = tab

# No standard. Please document a standard if different from .js
[**.md]
indent_style = tab

# Standard at:
[Makefile]
indent_style = tab
196 changes: 182 additions & 14 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,19 +1,187 @@
# OS Files
.DS_Store
~*
# ==================================================================SYSTEM FILES

# Python Files
__pycache__
# ===== WINDOWS
Thumbs.db
ehthumbs.db
Desktop.ini
$RECYCLE.BIN/
*.cab
*.msi
*.msm
*.msp
*.lnk
# ===== OSX
*.DS_Store
.AppleDouble
.LSOverride
Icon
._*
.DocumentRevisions-V100
.fseventsd
.Spotlight-V100
.TemporaryItems
.Trashes
.VolumeIcon.icns
.com.apple.timemachine.donotpresent
.AppleDB
.AppleDesktop
Network Trash Folder
Temporary Items
.apdisk
# ===== LINUX
.fuse_hidden*
.directory
.Trash-*

# ============================================== SETTINGS, RULES, AND MISC FILES

# ===== SUBLIME
*.sublime-project
*.sublime-workspace
sftp-config.json
*.tmlanguage.cache
*.tmPreferences.cache
*.stTheme.cache
Package Control.last-run
Package Control.ca-list
Package Control.ca-bundle
Package Control.system-ca-bundle
Package Control.cache/
Package Control.ca-certs/
bh_unicode_properties.cache
GitHub.sublime-settings
# ===== VIM
# swap
[._]*.s[a-w][a-z]
[._]s[a-w][a-z]
# session
Session.vim
# temporary
.netrwhist
*~
# auto-generated tag files
tags
# Visual Studio
.vscode/*
!.vscode/settings.json
!.vscode/tasks.json
!.vscode/launch.json
# ===== OTHERS
.idea/
.project
.cproject
.nodemonignore


# ======================================================================= PYTHON
# PYTHON CORE
__pycache__/
*.pyc
*.py[cod]
*$py.class
*.pcd
qtcreator-*
*.user
*.sqlite3
.so
pip-log.txt
pip-delete-this-directory.txt
pip-selfcheck.json
# ===== DJANGO
local_settings.py
# ===== SPHINX
docs/_build/
# ===== PYINSTALLER
*.manifest
*.spec
# ===== PYBUILDER
target/
# ===== JEKYLL
_site/
.jekyll-metadata
# ===== SCRAPY
.scrapy
# ===== IPYTHON
.ipynb_checkpoints/
.python-version
# ===== CELERY
celerybeat-schedule
# ===== VIRTUAL ENVIRONMENTS
.env
.venv/
venv/
ENV/
.Python
[Bb]in
[Ii]nclude
[Ll]ib
[Ll]ib64
[Ll]ocal
[Ss]cripts
pyvenv.cfg
.venv
# ===== TRANSLATION
*.mo
*.pot
public/i18n/*.js

# =========================================================== TESTING & COVERAGE
htmlcov/
.tox/
.coverage
.coverage.*
.cache
nosetests.xml
coverage.xml
*,cover
.hypothesis/


# =========================================================== AUTOMATION & TASKS
# ===== GRUNT

# ===== GULP

# ===== LARAVEL/HOMESTEAD
Homestead.yaml
Homestead.json
/public/css/
/public/js/
/vendor

# Build Files
*.egg-info
MANIFEST
htmlcov
build
dist
# ===== SASS/LASS
.sass-cache/
*.css.map
# ===== OTHER GENERATED DOCS
*.dox
*.wikidoc

# ================================================================== VIRTUAL BOX
# ===== VAGRANT
.vagrant/
# ===== ANSIBLE
.secrets.yml

# Testing files
.pypirc
.testing*
# =================================================== DISTRUBTION & NODEJS/BOWER
bin/
bower_components/
build/
develop=eggs/
dist/
downloads/
eggs/
env/
include/
local/
lib/
lib64/
man/
node_modules/
parts/
sdist/
tmp/
.installed.cfg
.eggs/
*.log
*.egg-info/
*.egg
13 changes: 7 additions & 6 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -1,28 +1,29 @@
# test in python
language: python
sudo: false
# python versions tested
python:
- "3.5"
- "3.6"
- "3.6.2"
# enable the use of sudo
sudo: required
# operating system to use
# set os
os: linux
# distribution to use
# set distribution
dist: trusty
# setting environment variables
# set environment variables
env:
- PACKAGE_VERSION=0.0.1
# command to install dependencies
# install dependencies
install:
- pip install -r requirements-dev.txt
# command to run tests
# launch test discovery and run tests
script:
- nose2
# send results to coveralls.io
after_success:
coveralls
# never give email notifications
notifications:
on_success: never
on_failure: never
25 changes: 25 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Changelog
All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).

## [Unreleased]

* Additions...
* files module
* text module
* web module

## [0.0.1]

* Changes...
* Project renamed to dhelp
* Each module passing tests(see below)
* Project documentation added to README.md
* Additions...
* Unit testing for files, text, and web modules added
* Test coverage added with computer-readable (.coverage) and human-friendly (an html folder, htmlcov)
* Continuous Integration support for Travis-CI and Coveralls
* .editorconfig added to enforce project standards
* To document changes, both past and future, added CHANGELOG.md and TODO.md
Loading

0 comments on commit ec825d4

Please sign in to comment.