Skip to content

Commit 48de138

Browse files
enryHsayalaruano
andauthored
restructure package layout (#42)
* 🔥 remove old code in setup.py * 🎨 src package layout * 🐛 specify path correctly for module * 🐛 Fix(report_config_micw2graph.yaml): Modify the component paths by adding "docs" to run vuegen from root * 🐛 Fix(cdci.yml): Remove cd docs fro tests * 🐛 Fix(cdci.yml): Add docs to the config paths * 🎨 change to directory based execution --------- Co-authored-by: sayalaruano <sebasar1245@gmail.com>
1 parent a787ced commit 48de138

File tree

11 files changed

+4
-54
lines changed

11 files changed

+4
-54
lines changed

.github/workflows/docs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ jobs:
3030
- name: Build references
3131
run: |
3232
cd docs
33-
sphinx-apidoc --force --implicit-namespaces --module-first -o reference ../vuegen
33+
sphinx-apidoc --force --implicit-namespaces --module-first -o reference ../src/vuegen
3434
- name: Build documentation
3535
run: |
3636
cd docs

docs/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ Options:
2626
```bash
2727
# pwd: docs
2828
# apidoc
29-
sphinx-apidoc --force --implicit-namespaces --module-first -o reference ../vuegen
29+
sphinx-apidoc --force --implicit-namespaces --module-first -o reference ../src/vuegen
3030
# build docs
3131
sphinx-build -n -W --keep-going -b html ./ ./_build/
3232
```

setup.py

Lines changed: 2 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -1,54 +1,4 @@
11
# builtin
2-
import setuptools
2+
from setuptools import setup
33

4-
def get_long_description():
5-
with open("README.md", "r") as readme_file:
6-
long_description = readme_file.read()
7-
return long_description
8-
9-
10-
def get_requirements():
11-
with open('requirements.txt') as f:
12-
required = f.read().splitlines()
13-
return required
14-
15-
16-
def create_pip_wheel():
17-
requirements = get_requirements()
18-
setuptools.setup(
19-
name="report_generator",
20-
version="0.1.0",
21-
license="MIT",
22-
description="An open-source Python package for generating reports for Omics datasets",
23-
long_description=get_long_description(),
24-
long_description_content_type="text/markdown",
25-
author="Multi-omics Network Analytics lab",
26-
author_email="albsad@dtu.dk",
27-
url="",
28-
project_urls={
29-
"Multi-omics Network Analytics": "",
30-
"GitHub": "",
31-
"ReadTheDocs": "",
32-
"PyPi": "",
33-
"Scientific paper": "https://www.nature.com/articles/s41587-021-01145-6",
34-
},
35-
keywords=["dashboard", "bioinformatics", "multi-omics",],
36-
classifiers=[
37-
"Intended Audience :: Science/Research",
38-
"License :: OSI Approved :: MIT License",
39-
"Operating System :: OS Independent",
40-
"Programming Language :: Python :: 3",
41-
"Topic :: Scientific :: Bioinformatics",
42-
],
43-
packages=[
44-
"report",
45-
],
46-
include_package_data=True,
47-
entry_points={},
48-
install_requires=requirements,
49-
python_requires=">=3.9,<4",
50-
)
51-
52-
53-
if __name__ == "__main__":
54-
create_pip_wheel()
4+
setup()
File renamed without changes.

0 commit comments

Comments
 (0)