Skip to content

Commit bc512ad

Browse files
author
James K. Glasbrenner
committed
Update setup file and project metadata
1 parent 2b6de67 commit bc512ad

File tree

3 files changed

+27
-2
lines changed

3 files changed

+27
-2
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -349,6 +349,7 @@ local_settings.py
349349
nosetests.xml
350350
pip-log.txt
351351
pip-delete-this-directory.txt
352+
*.egg-info/
352353
__pycache__/
353354
develop-eggs/
354355
docs/_build/

MANIFEST.in

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
include README.rst LICENSE
2+
3+
graft docs
4+
5+
global-exclude *.py[co]
6+
7+
prune docs/_build
8+
prune docs/_themes

setup.py

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,14 @@
11
#!/usr/bin/env python
2+
# -*- coding: utf-8 -*-
3+
4+
from collections import OrderedDict
25

36
import setuptools
47
from sphinx.setup_command import BuildDoc
58

9+
with open('README.rst', 'rt', encoding='utf8') as f:
10+
readme = f.read()
11+
612
name = "neighbormodels"
713
version = "0.0"
814
release = "0.0.1"
@@ -13,19 +19,29 @@
1319
author_email="[email protected]",
1420
license="MIT",
1521
version=release,
22+
url="https://github.com/jkglasbrenner/datamaterials-neighbormodels",
23+
project_urls=OrderedDict((
24+
("Documentation", "https://neighbormodels.readthedocs.io"),
25+
("Code", "https://github.com/jkglasbrenner/datamaterials-neighbormodels"),
26+
)),
1627
description=(
1728
"A tool for building crystal lattice models with distance-dependent "
1829
"neighbor interactions."
1930
),
31+
long_description=readme,
2032
python_requires=">=3.6",
21-
packages=setuptools.find_packages("src"),
22-
package_dir={"": "src"},
33+
packages=setuptools.find_packages(),
2334
include_package_data=True,
2435
install_requires=[
2536
"numpy",
2637
"pandas",
2738
"pymatgen",
2839
],
40+
extras_require={
41+
"docs": [
42+
"sphinx",
43+
],
44+
},
2945
cmdclass={"build_sphinx": BuildDoc},
3046
command_options={
3147
"build_sphinx": {

0 commit comments

Comments
 (0)