Skip to content

Commit

Permalink
Fix for (#15);Update package_name key to make_dirs;Add python3 support
Browse files Browse the repository at this point in the history
  • Loading branch information
NathanUrwin committed Mar 15, 2018
1 parent 1b19de1 commit 1575368
Show file tree
Hide file tree
Showing 28 changed files with 401 additions and 191 deletions.
171 changes: 171 additions & 0 deletions .gitignore
@@ -0,0 +1,171 @@

# Created by https://www.gitignore.io/api/windows,macos,linux,git,python

### Git ###
*.orig

### Linux ###
*~

# temporary files which can be created if a process still has a handle open of a deleted file
.fuse_hidden*

# KDE directory preferences
.directory

# Linux trash folder which might appear on any partition or disk
.Trash-*

# .nfs files are created when an open file is removed but is still being accessed
.nfs*

### macOS ###
*.DS_Store
.AppleDouble
.LSOverride

# Icon must end with two \r
Icon

# Thumbnails
._*

# Files that might appear in the root of a volume
.DocumentRevisions-V100
.fseventsd
.Spotlight-V100
.TemporaryItems
.Trashes
.VolumeIcon.icns
.com.apple.timemachine.donotpresent

# Directories potentially created on remote AFP share
.AppleDB
.AppleDesktop
Network Trash Folder
Temporary Items
.apdisk

### Python ###
# 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

# 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
.pytest_cache/
nosetests.xml
coverage.xml
*.cover
.hypothesis/

# Translations
*.mo
*.pot

# 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/

### Windows ###
# Windows thumbnail cache files
Thumbs.db
ehthumbs.db
ehthumbs_vista.db

# Folder config file
Desktop.ini

# Recycle Bin used on file shares
$RECYCLE.BIN/

# Windows Installer files
*.cab
*.msi
*.msm
*.msp

# Windows shortcuts
*.lnk


# End of https://www.gitignore.io/api/windows,macos,linux,git,python
2 changes: 1 addition & 1 deletion AUTHORS.md
@@ -1,7 +1,7 @@
# Authors

## Project Lead
[Nathan Urwin](https://github.com/tuxredux) <tuxredux2@gmail.com>
[Nathan Urwin](https://github.com/nathanurwin) <nathan.e.urwin@gmail.com>

## Contributors
None yet. [Why not be the first?](CONTRIBUTING.md)
28 changes: 14 additions & 14 deletions CHANGELOG.md
@@ -1,32 +1,32 @@
# Change Log

## [v0.3.0](https://github.com/webevllc/cookiecutter-git/tree/v0.3.0) (2017-03-25)
[Full Changelog](https://github.com/webevllc/cookiecutter-git/compare/v0.2.0...v0.3.0)
## [v0.3.0](https://github.com/nathanurwin/cookiecutter-git/tree/v0.3.0) (2017-03-25)
[Full Changelog](https://github.com/nathanurwin/cookiecutter-git/compare/v0.2.0...v0.3.0)

**Implemented enhancements:**

- Add cookiecutter.json documentation [\#14](https://github.com/webevllc/cookiecutter-git/issues/14)
- Refactor cookiecutter.json keys [\#13](https://github.com/webevllc/cookiecutter-git/issues/13)
- Add cookiecutter.json documentation [\#14](https://github.com/nathanurwin/cookiecutter-git/issues/14)
- Refactor cookiecutter.json keys [\#13](https://github.com/nathanurwin/cookiecutter-git/issues/13)

## [v0.2.0](https://github.com/webevllc/cookiecutter-git/tree/v0.2.0) (2017-03-24)
[Full Changelog](https://github.com/webevllc/cookiecutter-git/compare/v0.1.0...v0.2.0)
## [v0.2.0](https://github.com/nathanurwin/cookiecutter-git/tree/v0.2.0) (2017-03-24)
[Full Changelog](https://github.com/nathanurwin/cookiecutter-git/compare/v0.1.0...v0.2.0)

**Implemented enhancements:**

- Bitbucket.org support [\#5](https://github.com/webevllc/cookiecutter-git/issues/5)
- First tagged release [\#3](https://github.com/webevllc/cookiecutter-git/issues/3)
- Bitbucket.org support [\#5](https://github.com/nathanurwin/cookiecutter-git/issues/5)
- First tagged release [\#3](https://github.com/nathanurwin/cookiecutter-git/issues/3)

## [v0.1.0](https://github.com/webevllc/cookiecutter-git/tree/v0.1.0) (2017-03-24)
## [v0.1.0](https://github.com/nathanurwin/cookiecutter-git/tree/v0.1.0) (2017-03-24)
**Implemented enhancements:**

- More license choices [\#4](https://github.com/webevllc/cookiecutter-git/issues/4)
- Use github-changelog-generator [\#2](https://github.com/webevllc/cookiecutter-git/issues/2)
- Gitlab.com support [\#1](https://github.com/webevllc/cookiecutter-git/issues/1)
- More license choices [\#4](https://github.com/nathanurwin/cookiecutter-git/issues/4)
- Use github-changelog-generator [\#2](https://github.com/nathanurwin/cookiecutter-git/issues/2)
- Gitlab.com support [\#1](https://github.com/nathanurwin/cookiecutter-git/issues/1)

**Fixed bugs:**

- Insecure gitlab\_token retrieval [\#6](https://github.com/webevllc/cookiecutter-git/issues/6)
- Insecure gitlab\_token retrieval [\#6](https://github.com/nathanurwin/cookiecutter-git/issues/6)



\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*
\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Expand Up @@ -16,6 +16,6 @@ Make sure to have atomic commits and contextual commit messages!

[Check out this awesome blog post by Chris Beams for more information.][3]

[1]: https://github.com/tuxredux/cookiecutter-git/issues/new
[2]: https://github.com/tuxredux/cookiecutter-git/compare
[1]: https://github.com/nathanurwin/cookiecutter-git/issues/new
[2]: https://github.com/nathanurwin/cookiecutter-git/compare
[3]: http://chris.beams.io/posts/git-commit/
2 changes: 1 addition & 1 deletion LICENSE
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2017 Nathan Urwin
Copyright (c) 2018 Nathan Urwin

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
25 changes: 13 additions & 12 deletions README.md
@@ -1,6 +1,7 @@
# cookiecutter-git
A git repository project template!

### Table of Contents
- [Features](#features)
- [Upcoming](#upcoming)
- [Requirements](#requirements)
Expand All @@ -13,7 +14,7 @@ A git repository project template!
- [License](#license)

## Features
- [Bare project structure](https://github.com/tuxredux/cookiecutter-git-example)
- [Bare project structure](https://github.com/nathanurwin/cookiecutter-git-example)
- For any programming language or codebase
- Useful but not overruling organization
- [License customization](https://developer.github.com/v3/licenses/)
Expand All @@ -37,31 +38,31 @@ A git repository project template!
- [cookiecutter](https://github.com/audreyr/cookiecutter)

## Usage
$ cookiecutter gh:tuxredux/cookiecutter-git
$ cookiecutter gh:nathanurwin/cookiecutter-git

Which is an alias for:

$ cookiecutter https://github.com/tuxredux/cookiecutter-git
$ cookiecutter https://github.com/nathanurwin/cookiecutter-git

See generated [README.md]({{cookiecutter.repository_slug}}/README.md)
See generated [README.md]({{cookiecutter.repo_slug}}/README.md)

### Example
See [cookiecutter-git-example](https://github.com/tuxredux/cookiecutter-git-example)
See [cookiecutter-git-demo](https://github.com/nathanurwin/cookiecutter-git-demo)

$ tree -a -I .git cookiecutter-git-example
$ tree -a -I .git cookiecutter-git-demo
cookiecutter-git-example
├── AUTHORS.md
├── CHANGELOG.md
├── CONTRIBUTING.md
├── .editorconfig
└── example_package
│  └── .gitkeep
├── .editorconfig
├── .gitignore
├── LICENSE
├── NOTICE
└── README.md

1 directories, 9 files
3 directories, 9 files

## Documentation
**cookiecutter.json** explained in-depth. See [cookiecutter.json](cookiecutter.json) for default values.
Expand All @@ -71,10 +72,10 @@ Prompt | Explanation
`author_name` | Your full name, including first and last names, titles, and possibly even your middle name. This will go under *Project Lead* in **AUTHORS.md**.
`author_email` | The email address you want associated with the repository. This will go under *Project Lead* in **AUTHORS.md**.
`git_username` | Your local git and `remote_provider` (see below) account username. This will be used for all git-based actions.
`repository_namespace` | The namespace where the repository will live, which can be a user or organization, group, or team (depending on the `remote_provider`). This will only be used if `create_remote` (see below) is `yes`.
`repository_slug` | The repository name which should only contain alphanumeric characters and dashes. This will be the local, top-level directory name, the remote endpoint, and the *H1* in the **README.md**.
`repository_description` | A short description about the repository. This will be the remote description setting, and the content under the *H1* in the **README.md**.
`package_name` | The child directory name. This will be dependent on your codebase. For example, the default value contains only alphanumeric characters and underscores suitable for [python development](https://www.python.org/dev/peps/pep-0008/).
`repo_namespace` | The namespace where the repository will live, which can be a user or organization, group, or team (depending on the `remote_provider`). This will only be used if `create_remote` (see below) is `yes`.
`repo_slug` | The repository name which should only contain alphanumeric characters and dashes. This will be the local, top-level directory name, the remote endpoint, and the *H1* in the **README.md**.
`repo_description` | A short description about the repository. This will be the remote description setting, and the content under the *H1* in the **README.md**.
`make_dirs` | A comma-separated values list of directory names. These will be made with a `.gitkeep` file, so the dirs will be added to the initial commit.
`create_remote` | A `yes` or `no` choice on whether or not a remote repository is automatically created for you. This option is the main reason for *cookiecutter-git*, so the default choice is `yes`.
`remote_provider` | A choice between the three main, git, remote repository providers. This will only be used if `create_remote` is `yes`, and defaults to `github.com`.
`gitignore` | A comma-separated values list of preset templates of files for git to ignore. See the [gitignore.io docs](https://github.com/joeblau/gitignore.io#list) for a complete list of available values. This will be used to generate the **.gitignore** file.
Expand Down
24 changes: 12 additions & 12 deletions cookiecutter.json
@@ -1,25 +1,25 @@
{
"author_name": "Nathan Urwin",
"author_email": "tuxredux2@gmail.com",
"git_username": "tuxredux",
"repository_namespace": "tuxredux",
"repository_slug": "cookiecutter-git-example",
"repository_description": "An example cookiecutter-git project",
"package_name": "example_package",
"create_remote": ["yes", "no"],
"author_email": "nathan.e.urwin@gmail.com",
"git_username": "nathanurwin",
"repo_namespace": "nathanurwin",
"repo_slug": "cookiecutter-git-demo",
"repo_description": "A cookiecutter-git demonstration",
"make_dirs": "docs,src,tests",
"create_remote": ["no", "yes", "no"],
"remote_provider": ["github.com", "gitlab.com", "bitbucket.org"],
"gitignore": "windows,osx,linux,git",
"gitignore": "windows,macos,linux,git",
"license": [
"Apache-2.0",
"GPL-3.0",
"MIT",
"Apache-2.0",
"BSD-2-Clause",
"BSD-3-Clause",
"EPL-1.0",
"AGPL-3.0",
"GPL-2.0",
"GPL-3.0",
"AGPL-3.0",
"LGPL-2.1",
"LGPL-3.0",
"EPL-1.0",
"MPL-2.0",
"Unlicense"
],
Expand Down

0 comments on commit 1575368

Please sign in to comment.