Skip to content

Commit 912f65e

Browse files
committed
fix: Update personalized files and correct bug on cookiecutter installer
1 parent 2492af8 commit 912f65e

File tree

5 files changed

+63
-71
lines changed

5 files changed

+63
-71
lines changed

cookiecutter.json

+2-2
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22
"full_name": "Hello World",
33
"email": "[email protected]",
44
"github_username": "activandoideas",
5-
"author_name": "{{cookiecutter.github_username}}",
5+
"author_name": "{{cookiecutter.full_name}} | @{{cookiecutter.github_username}}",
66
"project_name": "",
7-
"version": "0.1.0",
87
"project_slug": "{{cookiecutter.project_name.lower().replace(' ', '_').replace('-', '_')}}",
98
"description": "{{cookiecutter.project_name}}",
9+
"version": "0.1.0",
1010
"open_source_license": ["MIT license", "BSD license", "ISC license", "Apache Software License 2.0", "GNU General Public License v3", "Not open source"]
1111
}

hooks/post_gen_project.py

+3-6
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
#!/usr/bin/env python
21
import os
32

43
PROJECT_DIRECTORY = os.path.realpath(os.path.curdir)
@@ -10,9 +9,7 @@ def remove_file(filepath):
109

1110
if __name__ == '__main__':
1211

13-
if '{{ cookiecutter.create_author_file }}' != 'y':
14-
remove_file('AUTHORS.rst')
15-
remove_file('docs/authors.rst')
16-
1712
if 'Not open source' == '{{ cookiecutter.open_source_license }}':
18-
remove_file('LICENSE')
13+
remove_file('LICENSE')
14+
15+
remove_file('MANIFEST.in')

{{cookiecutter.project_slug}}/AUTHORS.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
# Development Lead
88

9-
* {{ cookiecutter.full_name }} <{{ cookiecutter.email }}>
9+
* {{ cookiecutter.author_name }} <{{ cookiecutter.email }}>
1010

1111
# Contributors
1212

+55-60
Original file line numberDiff line numberDiff line change
@@ -1,91 +1,84 @@
11
# Contributing
22

3-
Contributions are welcome, and they are greatly appreciated! Every little bit
4-
helps, and credit will always be given.
5-
6-
You can contribute in many ways:
3+
Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given. You can contribute in many ways:
74

85
## Types of Contributions
96

107
### Report Bugs
118

12-
```txt
13-
Report bugs at https://github.com/{{ cookiecutter.github_username }}/{{ cookiecutter.project_slug }}/issues.
14-
15-
If you are reporting a bug, please include:
16-
17-
* Your operating system name and version.
18-
* Any details about your local setup that might be helpful in troubleshooting.
19-
* Detailed steps to reproduce the bug.
20-
```
9+
> ---
10+
> Report bugs at https://github.com/{{ cookiecutter.github_username }}/{{ cookiecutter.project_slug }}/issues.
11+
>
12+
>If you are reporting a bug, please include:
13+
>
14+
> * Your operating system name and version.
15+
> * Any details about your local setup that might be helpful in troubleshooting.
16+
> Detailed steps to reproduce the bug.
17+
>
18+
> ---
2119
2220
### Fix Bugs
2321

24-
```txt
25-
Look through the GitHub issues for bugs. Anything tagged with "bug" and "help
26-
wanted" is open to whoever wants to implement it.
22+
> ---
23+
> Look through the GitHub issues for bugs. Anything tagged with "bug" and "help
24+
> wanted" is open to whoever wants to implement it.
25+
>
26+
> ---
2727
28-
Implement Features
29-
```
28+
### Implement Features
3029

31-
Look through the GitHub issues for features. Anything tagged with "enhancement"
32-
and "help wanted" is open to whoever wants to implement it.
30+
> ---
31+
> Look through the GitHub issues for features. Anything tagged with "enhancement"
32+
> and "help wanted" is open to whoever wants to implement it.
33+
>
34+
> ---
3335
3436
### Write Documentation
3537

36-
```txt
37-
{{ cookiecutter.project_name }} could always use more documentation, whether as part of the
38-
official {{ cookiecutter.project_name }} docs, in docstrings, or even on the web in blog posts,
39-
articles, and such.
40-
```
38+
> ---
39+
> Personal Site could always use more documentation, whether as part of the
40+
> official Personal Site docs, in docstrings, or even on the web in blog posts, articles, and such.
41+
>
42+
> ---
4143
4244
### Submit Feedback
4345

44-
```txt
45-
The best way to send feedback is to file an issue at https://github.com/{{ cookiecutter.github_username }}/{{ cookiecutter.project_slug }}/issues.
46-
If you are proposing a feature:
47-
48-
* Explain in detail how it would work.
49-
* Keep the scope as narrow as possible, to make it easier to implement.
50-
* Remember that this is a volunteer-driven project, and that contributions
46+
> ---
47+
> The best way to send feedback is to file an issue at https://github.com/{{ cookiecutter.github_username }}/{{ cookiecutter.project_slug }}/issues.
48+
> If you are proposing a feature:
49+
>
50+
> * Explain in detail how it would work.
51+
> * Keep the scope as narrow as possible, to make it easier to implement.
52+
> * Remember that this is a volunteer-driven project, and that contributions
5153
are welcome :)
52-
```
54+
> ---
5355
5456
### Get Started!
5557

56-
Ready to contribute? Here's how to set up `{{ cookiecutter.project_slug }}` for local development.
58+
Ready to contribute? Here's how to set up `personal_site` for local development.
5759

58-
1. Fork the `{{ cookiecutter.project_slug }}` repo on GitHub.
60+
1. Fork the `personal_site` repo on GitHub.
5961
2. Clone your fork locally::
6062

61-
$ git clone [email protected]:your_name_here/{{ cookiecutter.project_slug }}.git
63+
`$ git clone [email protected]:{{ cookiecutter.github_username }}/{{ cookiecutter.project_slug }}.git
6264

6365
3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development::
6466

65-
$ mkvirtualenv {{ cookiecutter.project_slug }}
66-
$ cd {{ cookiecutter.project_slug }}/
67-
$ python setup.py develop
68-
6967
4. Create a branch for local development::
7068

71-
$ git checkout -b name-of-your-bugfix-or-feature
72-
73-
Now you can make your changes locally.
69+
`git checkout -b name-of-your-bugfix-or-feature`
7470

75-
5. When you're done making changes, check that your changes pass flake8 and the
76-
tests, including testing other Python versions with tox::
71+
Now you can make your changes locally.
7772

78-
$ flake8 {{ cookiecutter.project_slug }} tests
79-
$ python setup.py test or pytest
80-
$ tox
81-
82-
To get flake8 and tox, just pip install them into your virtualenv.
73+
5. When you're done making changes, check that your changes pass linters and tests
8374

8475
6. Commit your changes and push your branch to GitHub::
8576

86-
$ git add .
87-
$ git commit -m "Your detailed description of your changes."
88-
$ git push origin name-of-your-bugfix-or-feature
77+
```
78+
git add .
79+
git commit -m "Your detailed description of your changes."
80+
git push origin name-of-your-bugfix-or-feature
81+
```
8982

9083
7. Submit a pull request through the GitHub website.
9184

@@ -97,18 +90,20 @@ Before you submit a pull request, check that it meets these guidelines:
9790
2. If the pull request adds functionality, the docs should be updated. Put
9891
your new functionality into a function with a docstring, and add the
9992
feature to the list in README.rst.
100-
3. The pull request should work for Python 3.5, 3.6, 3.7 and 3.8, and for PyPy. Check
101-
https://travis-ci.com/{{ cookiecutter.github_username }}/{{ cookiecutter.project_slug }}/pull_requests
93+
3. The pull request should work for Python 3.5, 3.6, 3.7 and 3.8. Check
94+
https://travis-ci.com/eocode/personal_site/pull_requests
10295
and make sure that the tests pass for all supported Python versions.
10396

10497
### Deploying
10598

10699
A reminder for the maintainers on how to deploy.
107-
Make sure all your changes are committed (including an entry in HISTORY.rst).
100+
Make sure all your changes are committed (including an entry in CHANGELOG.md)
101+
108102
Then run::
109103

110-
$ bump2version patch # possible: major / minor / patch
111-
$ git push
112-
$ git push --tags
104+
Describe version patch # possible: major / minor / patch
113105

114-
Travis will then deploy to PyPI if tests pass.
106+
```
107+
git push
108+
git push --tags
109+
```

{{cookiecutter.project_slug}}/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,9 @@ Your demo project
2323

2424
## How to clone
2525

26-
You can clone the repository
26+
You can clone this repository
2727

28-
clone url
28+
git clone https://github.com/{{ cookiecutter.github_username }}/{{ cookiecutter.project_slug }}
2929

3030
## Use on local
3131
To install this project just type

0 commit comments

Comments
 (0)