DAI-Lab / cookiecutter-pypackage

DAI Lab's adaptation of cookiecutter-pypackage
BSD 3-Clause "New" or "Revised" License
1 stars 5 forks source link

Add license owner, repository_name and pacakge_name #37

Closed csala closed 4 years ago

csala commented 4 years ago

Rename variable github_orgname to github_owner.

Resolve #20 : Add 2 new variables, license_owner and license_owner_email, which default to the username and username e-mail only if the github_owner == username. Otherwise, they default to DAI-Lab values. These variables are used in setup.py, LICENSE and the documentation configuration.

Resolve #21: Add 2 new variables, package_name and repository_name. package_name defaults to the project_name in lowercase and replacing white spaces by dashes. The repository_name defaults to the package_name. Finally, the project_slug now defaults to the package_name replacing the dashes by underscores.

The new package_name variable is used on the setup.py, README.md and docs/installation.rst files to properly point at the right PyPi package.

The new repository_name is used in all the places where the repository URL is created, as well as in the README, to point at the right travis site. Also, the newly generated folder is now named after the repository_name instead of the project_slug, which is the name that a freshly cloned repository would have.

This new combination of variables has been created to allow situations like this: