-
Notifications
You must be signed in to change notification settings - Fork 13
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
using the latest cookiecutter to make maintenance easier #93
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please see comments.
Leave LICENSE as it was.
LICENSE
Outdated
|
||
Redistribution and use in source and binary forms, with or without | ||
modification, are permitted provided that the following conditions are met: | ||
Copyright 2024, alchemtest developers |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Copyright 2024, alchemtest developers | |
Copyright (c) 2017-2024, alchemtest developers |
LICENSE
Outdated
@@ -1,28 +1,21 @@ | |||
Copyright (c) 2017, alchemtest developers |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Keep the original license file. I don't want to have to think like a lawyer and figure out if the old and the new one are equivalent. Just keep the old file verbatim.
# omit the versioneer-installed _version.py | ||
src/alchemtest/_version.py | ||
alchemtest/_version.py |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do we still have a file _version.py
?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It is automatically generated by git versioneer when you pip install it. Looks like
__version__ = "0.10.0.dev0"
.github/workflows/CI.yaml
Outdated
- name: Additional info about the build | ||
shell: bash | ||
run: | | ||
uname -a | ||
df -h | ||
ulimit -a |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We can probably delete this section — I don't think I ever cared about this info.
docs/conf.py
Outdated
|
||
# -- General configuration ------------------------------------------------ | ||
project = 'alchemtest' | ||
copyright = ("2024, David Dotson, Zhiyi Wu. Project structure based on the " |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
2017-2024 and include all authors or "The Alchemtest Authors"
docs/conf.py
Outdated
project = 'alchemtest' | ||
copyright = ("2024, David Dotson, Zhiyi Wu. Project structure based on the " | ||
"Computational Molecular Science Python Cookiecutter version 1.1") | ||
author = 'David Dotson, Zhiyi Wu' |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
all authors
docs/conf.py
Outdated
author = 'David Dotson, Zhiyi Wu' | ||
|
||
# The short X.Y version | ||
version = '' |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
use alchemtest.__version__
docs/conf.py
Outdated
# The short X.Y version | ||
version = '' | ||
# The full version, including alpha/beta/rc tags | ||
release = '' |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
set to version
Co-authored-by: Oliver Beckstein <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
lgtm, I'll just include two small changes
For easier future maintenance, I think it would be good for this repo to adopt the MOLSSI cookiecutter.
Then we could easily pull fix from there.
This PR also fixed RTD (See the build for this here https://alchemtest--93.org.readthedocs.build/en/93/)
Also fixes #92
Tested in https://github.com/alchemistry/alchemlyb/actions/runs/8409355524/job/23026883761?pr=351
The versioner is gone in this PR.