Skip to content

Commit 48d2b76

Browse files
Add content from scientific-python.org/tools (#23)
1 parent 24ab41f commit 48d2b76

File tree

7 files changed

+178
-16
lines changed

7 files changed

+178
-16
lines changed

config.yaml

Lines changed: 4 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
baseURL: "https://tools.scientific-python.org/"
2-
title: "Scientific Python Tools"
2+
title: "Scientific Python Tools and Services"
33
theme: scientific-python-hugo-theme
44
relativeURLs: true
55
disableKinds: ["term", "taxonomy"]
@@ -9,12 +9,12 @@ markup:
99
noClasses: false
1010

1111
params:
12-
description: "Tools for scientific Python developers and packages."
12+
description: "Tools and services for scientific Python developers and packages."
1313
images:
1414
- /images/logo.svg
1515
navbarlogo:
1616
image: logo.svg
17-
text: Scientific Python Tools
17+
text: Scientific Python Tools and Services
1818
link: /
1919
navbarlogoshow: true
2020
navbar:
@@ -26,24 +26,13 @@ params:
2626
url: https://learn.scientific-python.org
2727
- title: Tools
2828
url: /
29-
panel:
30-
tiles:
31-
- buttonText: Web Theme
32-
url: https://theme.scientific-python.org
33-
text: ...
34-
- buttonText: Python Packages
35-
url: /
36-
text: ...
37-
- buttonText: Github Actions
38-
url: /
39-
text: ...
4029
footer:
4130
logo: logo.svg
4231
socialmediatitle: ""
4332
socialmedia:
4433
- link: https://scientific-python.org
4534
icon: scientific-python
46-
- link: https://github.com/scientific-python/learn.scientific-python.org
35+
- link: https://github.com/scientific-python/tools.scientific-python.org
4736
icon: github
4837
- link: https://www.youtube.com/c/ScientificPython-org
4938
icon: youtube

content/_index.md

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
---
2+
title: Tools & Services
3+
---
4+
5+
We maintain a collection of tools, small and large, that help projects across the ecosystem.
6+
All tools:
7+
8+
- are owned and developed by the community, for the community;
9+
- provide functionality needed by projects across the ecosystem;
10+
- are released under the liberal [3-Clause BSD](https://opensource.org/license/bsd-3-clause/) or [MIT](https://opensource.org/license/mit/) license;
11+
- attribute copyright to `Scientific Python Developers`;
12+
- follow our [Code of Conduct](https://scientific-python.org/code_of_conduct/); and
13+
- are hosted in the [Scientific Python GitHub Organization](https://github.com/scientific-python/).
14+
15+
We also list a few hosted services provided for the community.
16+
17+
{{< grid >}}
18+
19+
{{< card >}}
20+
title = 'Web Theme'
21+
link = 'https://theme.scientific-python.org'
22+
body = '''
23+
Our [Hugo](https://gohugo.io/) theme aims to align closely with the [PyData Sphinx Theme](https://pydata-sphinx-theme.readthedocs.io). It is used by [NumPy](https://numpy.org/), [SciPy](https://scipy.org/), [Scientific Python](https://scientific-python.org/), and other project sites.
24+
'''
25+
{{< /card >}}
26+
27+
{{< card >}}
28+
title = 'Developer utilities'
29+
link = '/utilities'
30+
body = '''
31+
The following Python packages provide functionality widely usable by packages across the ecosystem. Also see to the [Scientific Python Developer Guide](https://learn.scientific-python.org/development/).
32+
'''
33+
{{< /card >}}
34+
35+
{{< /grid >}}
36+
37+
{{< grid >}}
38+
39+
{{< card >}}
40+
title = 'Community & organization'
41+
link = '/community'
42+
body = '''
43+
...
44+
'''
45+
{{< /card >}}
46+
47+
{{< card >}}
48+
title = 'Analytics'
49+
link = '/analytics'
50+
body = '''
51+
...
52+
'''
53+
{{< /card >}}
54+
55+
{{< /grid >}}
56+
57+
{{< grid >}}
58+
59+
{{< card >}}
60+
title = 'GitHub Actions'
61+
link = '/actions'
62+
body = '''
63+
...
64+
'''
65+
{{< /card >}}
66+
67+
{{< card >}}
68+
title = 'New tools'
69+
body = '''
70+
If you have an existing tool that you would like to host and maintain as part of the Scientific Python project,
71+
please [create a New Topic](https://discuss.scientific-python.org/new-topic?category=contributor&tags=propose)
72+
describing your tool, its target audience, and its developer community.
73+
74+
We only host tools that are actively maintained, and will give your existing
75+
developer community full access to continue managing your repository.
76+
'''
77+
{{< /card >}}
78+
79+
{{< /grid >}}

content/actions/index.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
---
2+
title: "GitHub Actions"
3+
---
4+
5+
The following GitHub actions provide workflows that simplify various developer tasks.
6+
7+
- [upload-nightly-action](https://github.com/scientific-python/upload-nightly-action)
8+
9+
Uploads nightly builds to the [scientific-python conda channel](https://anaconda.org/scientific-python-nightly-wheels) as described in [SPEC4](https://scientific-python.org/specs/spec-0004/).
10+
11+
- [attach-next-milestone-action](https://github.com/scientific-python/attach-next-milestone-action)
12+
13+
When a PR is merged, attach it to the next upcoming milestone.
14+
15+
- [action-check-changelogfile](https://github.com/scientific-python/action-check-changelogfile)
16+
17+
Ensure that added changelog entries conform to certain rules.
18+
19+
- [action-towncrier-changelog](https://github.com/scientific-python/action-towncrier-changelog)
20+
21+
Ensure that changelog entries are present and correctly tagged.
22+
23+
- [reverse-dependency-testing](https://github.com/scientific-python/reverse-dependency-testing)
24+
25+
Query the conda-forge dependency tree and run test suites for packages that depend on your package.
26+
27+
- [sync-teams-action](https://github.com/scientific-python/sync-teams-action)
28+
29+
Manage teams and team membership for the Scientific Python GitHub organization.

content/analytics/index.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
title: "Analytics"
3+
---
4+
5+
- [devstats](https://github.com/scientific-python/devstats)
6+
7+
Generate developer statistics for a specified project.
8+
9+
- [views.scientific-python.org](https://views.scientific-python.org)
10+
11+
A hosted plausible instance where library authors can track website visits.
12+
You can [enable this service](https://pydata-sphinx-theme.readthedocs.io/en/latest/user_guide/analytics.html#analytics-and-usage-services)
13+
in your pydata-sphinx-theme settings.

content/community/index.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
title: "Community & organization"
3+
---
4+
5+
- [yaml2ics](https://github.com/scientific-python/yaml2ics)
6+
7+
Convert plain-text descriptions of calendar events into ICS files that can be loaded into Google Calendar etc.
8+
Used to host the Scientific Python [community calendars](https://scientific-python.org/calendar).
9+
10+
- [discuss.scientific-python.org](https://discuss.scientific-python.org)
11+
12+
A Discourse discussion forum for the Scientific Python developer community.
13+
Also see the [Scientific Python blog](https://blog.scientific-python.org).
14+
15+
- [vault](https://github.com/scientific-python/vault-template)
16+
17+
A GPG-based password vault. See also [SPEC 6](https://github.com/scientific-python/specs/pull/168).

content/utilities/index.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
title: "Developer Utilities"
3+
---
4+
5+
- [lazy_loader](https://github.com/scientific-python/lazy_loader/)
6+
7+
Implements lazy loading as described in [SPEC1](https://scientific-python.org/specs/spec-0001/).
8+
9+
- [spin](https://github.com/scientific-python/spin)
10+
11+
**S**cientific **P**ython **D**eveloper **I**ncantations: an extendible tool that
12+
provides uniform aliases for build tasks across the ecosystem (`spin build`, `spin docs`, etc.).
13+
14+
- [pytest-doctestplus](https://github.com/scientific-python/pytest-doctestplus)
15+
16+
A plugin for the pytest framework that provides advanced doctest
17+
support and enables the testing of text file formats.
18+
19+
- [repo-review](https://github.com/scientific-python/repo-review)
20+
21+
A framework for building checks designed to check to see if a
22+
repository follows guideline.
23+
24+
- [changelist](https://github.com/scientific-python/changelist/)
25+
26+
A tool for automating release notes.

layouts/index.html

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,12 @@
11
{{ define "main" }}
2-
{{ partial "panel.html" . }}
2+
3+
<section class="article content-padding">
4+
<div class="content-container">
5+
<div class="article-content">
6+
<!-- Note that the content for index.html, as a sort of list page, will pull from content/_index.md -->
7+
{{ .Content }}
8+
</div>
9+
</div>
10+
</section>
11+
312
{{ end }}

0 commit comments

Comments
 (0)