Skip to content

Commit d876452

Browse files
committed
Code cleaning
Funding: SCM ReaxPro EU203
1 parent eab59bb commit d876452

File tree

6 files changed

+46
-79
lines changed

6 files changed

+46
-79
lines changed

.editorconfig

Lines changed: 0 additions & 26 deletions
This file was deleted.

CONTRIBUTING.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
Thank you for your interest in contributing to the pyZacros project!
2+
3+
# How to contribute
4+
5+
We want to keep it as easy as possible to contribute changes that
6+
get things working in your environment. There are a few guidelines that we
7+
need contributors to follow so that we can have a chance of keeping on
8+
top of things.
9+
10+
## Getting Started
11+
12+
* Make sure you have a [GitHub account](https://github.com/signup/free)
13+
* Fork the repository on GitHub
14+
15+
## Making Changes
16+
17+
* Create a topic branch from where you want to base your work.
18+
* This is usually the master branch.
19+
* Only target release branches if you are certain your fix must be on that
20+
branch.
21+
* To quickly create a topic branch based on master; `git checkout -b
22+
fix/master/my_contribution master`. Please avoid working directly on the
23+
`master` branch.
24+
* Make commits of logical units.
25+
* Check for unnecessary whitespace with `git diff --check` before committing.
26+
* Make sure your commit messages are informative.
27+
* Make sure you have added the necessary tests for your changes.
28+
* Run _all_ the tests to assure nothing else was accidentally broken.
29+
30+
## Submitting Changes
31+
32+
* Push your changes to a topic branch in your fork of the repository.
33+
* Submit a pull request to the repository in the SCM-NV organization.
34+
* The core team looks at Pull Requests on a regular basis.
35+
36+
# Additional Resources
37+
38+
* [General GitHub documentation](https://help.github.com/)
39+
* [GitHub pull request documentation](https://help.github.com/send-pull-requests/)

CONTRIBUTING.rst

Lines changed: 0 additions & 44 deletions
This file was deleted.

MANIFEST.in

Lines changed: 0 additions & 2 deletions
This file was deleted.

__version__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
__version__ = '0.0.1'
1+
__version__ = '1.0.0'

setup.py

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -18,33 +18,33 @@
1818
setup(
1919
name='pyzacros',
2020
version=version['__version__'],
21-
description="A Python library to handle KMC codes.",
21+
description="Python Library for Automating Zacros Simulations",
2222
long_description=readme + '\n\n',
2323
author="Pablo Lopez-Tarifa",
2424
author_email='[email protected]',
25-
url='https://github.com/NLeSC/pyZacros',
25+
url='https://github.com/SCM-NV/pyZacros',
2626
packages=packages,
2727
package_dir = {'pyzacros': '.'},
28-
package_data={'pyzacros' : ['lattice_db/*', 'examples/*']},
28+
package_data={'pyzacros' : ['examples/*']},
2929
include_package_data=True,
3030
license="LGPLv3",
3131
zip_safe=False,
3232
keywords='pyZacros',
3333
classifiers=[
34-
'Development Status :: 2 - Pre-Alpha',
34+
'Development Status :: Alpha',
3535
'Intended Audience :: Developers',
3636
'License :: OSI Approved :: GNU Lesser General Public License v3 (LGPLv3)',
3737
'Natural Language :: English',
3838
'Programming Language :: Python :: 3',
39-
'Programming Language :: Python :: 3.6',
39+
'Programming Language :: Python :: 3.6',
4040
],
4141

4242
install_requires=[
4343
'pyaml', 'chemparse',
4444
'plams@git+https://github.com/SCM-NV/PLAMS@master'],
4545

4646
extras_require={
47-
'test': ['coverage', 'pycodestyle', 'pytest>=3.9', 'pytest-cov'],
47+
'test': ['coverage', 'pytest>=3.9', 'pytest-cov'],
4848
'doc': ['sphinx', 'sphinx_rtd_theme', 'nbsphinx']
4949
}
5050
)

0 commit comments

Comments
 (0)