Skip to content

Commit 169fd73

Browse files
tmorrelltmorrell
committed
Initial commit
0 parents  commit 169fd73

11 files changed

+364
-0
lines changed

Diff for: ‎.gitattributes

+36
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# -*- mode: sh; -*-
2+
3+
# Set the default behavior, in case people don't have core.autocrlf set.
4+
# .............................................................................
5+
6+
* text=auto
7+
8+
# Specify what's text and should be normalized.
9+
# .............................................................................
10+
11+
*.py text
12+
*.in text
13+
*.rst text
14+
*.cfg text
15+
*.ini text
16+
*.yml text
17+
*.json text
18+
*.bat text
19+
*.sh text
20+
LICENSE text
21+
CONTRIBUTING text
22+
23+
# Denote all files that are truly binary and should not be modified.
24+
# .............................................................................
25+
26+
*.png binary
27+
*.jpg binary
28+
*.xls binary
29+
*.doc binary
30+
31+
# This next one is because in other projects, we've had problems with git
32+
# getting confused about line endings when people using Windows and Mac edit
33+
# the same files.
34+
# .............................................................................
35+
36+
*.csv binary diff=csv

Diff for: ‎.gitignore

+81
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
# -*- sh -*-
2+
3+
# Compiled source
4+
# .............................................................................
5+
6+
*.com
7+
*.class
8+
*.dll
9+
*.exe
10+
*.o
11+
*.so
12+
*.dylib
13+
14+
# Compressed archives & package files
15+
# .............................................................................
16+
17+
*.7z
18+
*.dmg
19+
*.gz
20+
*.iso
21+
*.jar
22+
*.rar
23+
*.tar
24+
*.zip
25+
26+
# OS-specific things to ignore:
27+
# .............................................................................
28+
29+
.DS_Store
30+
.DS_Store?
31+
._*
32+
.Spotlight-V100
33+
.Trashes
34+
ehthumbs.db
35+
Thumbs.db
36+
37+
# Emacs-specific things to ignore:
38+
# .............................................................................
39+
40+
*~
41+
.#*
42+
.git/COMMIT_EDITMSG
43+
auto
44+
*.synctex.gz
45+
TAGS
46+
47+
# LaTeX-specific things to ignore:
48+
# .............................................................................
49+
50+
*.aux
51+
*.bbl
52+
*.blg
53+
*.fls
54+
*.loc
55+
*.lof
56+
*.log
57+
*.lot
58+
*.mp
59+
*.out
60+
*.toc
61+
*.toc
62+
63+
# Python-specific things to ignore:
64+
# .............................................................................
65+
66+
__pycache__
67+
*.py[cod]
68+
*$py.class
69+
70+
# InnoSetup-specific things to ignore:
71+
# .............................................................................
72+
73+
*.~is
74+
75+
# Jupyter Notebook-specific things to ignore:
76+
# .............................................................................
77+
78+
.ipynb_checkpoints
79+
80+
# Project-specific things to ignore:
81+
# .............................................................................

Diff for: ‎.graphics/caltech-round.png

27.4 KB
Loading

Diff for: ‎CHANGES.md

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
Change log for REPOSITORY
2+
=========================
3+
4+
Version 1.0.0
5+
-------------
6+
7+
* Write about a change here
8+
* Write about another change here
9+
* Write about a 3rd change

Diff for: ‎CODE_OF_CONDUCT.md

+44
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
Contributor Covenant Code of Conduct
2+
====================================
3+
4+
## Our Pledge
5+
6+
In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
7+
8+
## Our Standards
9+
10+
Examples of behavior that contributes to creating a positive environment include:
11+
12+
* Using welcoming and inclusive language
13+
* Being respectful of differing viewpoints and experiences
14+
* Gracefully accepting constructive criticism
15+
* Focusing on what is best for the community
16+
* Showing empathy towards other community members
17+
18+
Examples of unacceptable behavior by participants include:
19+
20+
* The use of sexualized language or imagery and unwelcome sexual attention or advances
21+
* Trolling, insulting/derogatory comments, and personal or political attacks
22+
* Public or private harassment
23+
* Publishing others' private information, such as a physical or electronic address, without explicit permission
24+
* Other conduct which could reasonably be considered inappropriate in a professional setting
25+
26+
## Our Responsibilities
27+
28+
Project contributors are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
29+
30+
Project contributors have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
31+
32+
## Scope
33+
34+
This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project contributors.
35+
36+
## Enforcement
37+
38+
If a contributor engages in harassing behaviour, the project organizers may take any action they deem appropriate, including warning the offender or expelling them from online forums, online project resources, face-to-face meetings, or any other project-related activity or resource.
39+
40+
If you are being harassed, notice that someone else is being harassed, or have any other concerns, please contact a member of the project team immediately. Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
41+
42+
## Attribution
43+
44+
Portions of this Code of Conduct were adapted from Electron's [Contributor Covenant Code of Conduct](https://github.com/electron/electron/blob/master/CODE_OF_CONDUCT.md), which itself was adapted from the [Contributor Covenant](http://contributor-covenant.org/version/1/4), version 1.4.

Diff for: ‎CONTRIBUTING.md

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Guidelines for contributing to this project
2+
3+
Any constructive contributions – bug reports, pull requests (code or documentation), suggestions for improvements, and more – are welcome.
4+
5+
## Conduct
6+
7+
Everyone is asked to read and respect the [code of conduct](CODE_OF_CONDUCT.md) before participating in this project.
8+
9+
## Coordinating work
10+
11+
A quick way to find out what is currently in the near-term plans for this project is to look at the [GitHub issue tracker](https://github.com/caltechlibrary/template/issues), but the possibilities are not limited to what you see there – if you have ideas for new features and enhancements, please feel free to write them up as a new issue or contact the developers directly!
12+
13+
## Submitting contributions
14+
15+
Please feel free to contact the author directly, or even better, jump right in and use the standard GitHub approach of forking the repo and creating a pull request. When committing code changes and submitting pull requests, please write a clear log message for your commits.

Diff for: ‎LICENSE

+28
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
Copyright (c) 2019, Caltech
2+
All rights not granted herein are expressly reserved by Caltech.
3+
4+
Redistribution and use in source and binary forms, with or without
5+
modification, are permitted provided that the following conditions are met:
6+
7+
1. Redistributions of source code must retain the above copyright notice,
8+
this list of conditions and the following disclaimer.
9+
10+
2. Redistributions in binary form must reproduce the above copyright notice,
11+
this list of conditions and the following disclaimer in the documentation
12+
and/or other materials provided with the distribution.
13+
14+
3. Neither the name of the copyright holder nor the names of its contributors
15+
may be used to endorse or promote products derived from this software without
16+
specific prior written permission.
17+
18+
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19+
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20+
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21+
ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
22+
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23+
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24+
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25+
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26+
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27+
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28+
POSSIBILITY OF SUCH DAMAGE.

Diff for: ‎LICENSE.html

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
<html>
2+
<body>
3+
<p> Copyright (c) 2018&ndash;2019, Caltech.<br>
4+
All rights not granted herein are expressly reserved by Caltech.
5+
6+
<p>Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
7+
8+
<p>&nbsp;&nbsp;&nbsp;&nbsp;1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
9+
10+
<p>&nbsp;&nbsp;&nbsp;&nbsp;2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
11+
12+
<p>&nbsp;&nbsp;&nbsp;&nbsp;3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
13+
14+
<p>THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
15+
</body>
16+
</html>

Diff for: ‎README.md

+102
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,102 @@
1+
Template for software repositories by the Caltech Library
2+
=====================================================
3+
4+
This is a template README file for software repositories. This first paragraph of the README should summarize your software in a concise fashion, preferably using no more than one or two sentences.
5+
6+
[![License](https://img.shields.io/badge/License-BSD%203--Clause-blue.svg?style=flat-square)](https://choosealicense.com/licenses/bsd-3-clause)
7+
[![Latest release](https://img.shields.io/github/v/release/caltechlibrary/template.svg?style=flat-square&color=b44e88)](https://github.com/caltechlibrary/template/releases)
8+
9+
10+
Table of contents
11+
-----------------
12+
13+
* [Introduction](#introduction)
14+
* [Installation](#installation)
15+
* [Usage](#usage)
16+
* [Known issues and limitations](#known-issues-and-limitations)
17+
* [Getting help](#getting-help)
18+
* [Contributing](#contributing)
19+
* [License](#license)
20+
* [Authors and history](#authors-and-history)
21+
* [Acknowledgments](#authors-and-acknowledgments)
22+
23+
24+
Introduction
25+
------------
26+
27+
This repository is a GitHub template repostory for creating software project repositories at the Caltech Library. The [associated wiki page](https://github.com/caltechlibrary/template/wiki/Using-this-template-repo) explains how to use the template repository.
28+
29+
This README file is in Markdown format, and is meant to provide a template for README files as well an illustration of what the README file can be expected to look like. For a software project, this [Introduction](#introduction) section &ndash; which you are presently reading &ndash; should provide background for the project, a brief explanation of what the project is about, and optionally, pointers to resources that can help orient readers. Ideally, this section should be short.
30+
31+
32+
Installation
33+
------------
34+
35+
Begin this section by mentioning any prerequisites that may be important for users to have before they can use your software. Examples include hardware and operating system requirements.
36+
37+
Next, provide step-by-step instructions for installing the software, preferably with command examples that can be copy-pasted by readers into their software environments. For example:
38+
39+
```bash
40+
a command-line command here
41+
```
42+
43+
Sometimes, subsections may be needed for different operating systems or particularly complicated installations.
44+
45+
46+
Usage
47+
-----
48+
49+
This [Usage](#usage) section would explain more about how to run the software, what kind of behavior to expect, and so on.
50+
51+
### _Basic operation_
52+
53+
Begin with the simplest possible example of how to use your software. Provide example command lines and/or screen images, as appropriate, to help readers understand how the software is expected to be used. Many readers are likely to look for command lines they can copy-paste directly from your explanations, so it's best to keep that in mind as you write examples.
54+
55+
### _Additional options_
56+
57+
Some projects need to communicate additional information to users and can benefit from additional sections in the README file. It's difficult to give specific instructions &ndash; a lot depends on your software, your intended audience, etc. Use your judgement and ask for feedback from users or colleagues to help figure out what else is worth explaining.
58+
59+
60+
Known issues and limitations
61+
----------------------------
62+
63+
In this section, summarize any notable issues and/or limitations of your software. If none are known yet, this section can be omitted (and don't forget to remove the corresponding entry in the [Table of Contents](#table-of-contents) too); alternatively, you can leave this section in and write something along the lines of "none are known at this time".
64+
65+
66+
Getting help
67+
------------
68+
69+
Inform readers of how they can contact you, or at least how they can report problems they may encounter. This may simply be a request to use the issue tracker on your repository, but many projects have associated chat or mailing lists, and this section is a good place to mention those.
70+
71+
72+
Contributing
73+
------------
74+
75+
This section is optional; if your repository is for a project that accepts open-source contributions, then this section is where you can mention how people can offer contributions, and point them to your guidelines for contributing. (If you delete this section, don't forget to remove the corresponding entry in the [Table of Contents](#table-of-contents) too.)
76+
77+
78+
License
79+
-------
80+
81+
Software produced by the Caltech Library is Copyright (C) 2019, Caltech. This software is freely distributed under a BSD/MIT type license. Please see the [LICENSE](LICENSE) file for more information.
82+
83+
84+
Authors and history
85+
---------------------------
86+
87+
In this section, list the authors and contributors to your software project. Adding additional notes here about the history of the project can make it more interesting and compelling. This is also a place where you can acknowledge other contributions to the work and the use of other people's software or tools.
88+
89+
90+
Acknowledgments
91+
---------------
92+
93+
This work was funded by the California Institute of Technology Library.
94+
95+
(If this work was also supported by other organizations, acknowledge them here. In addition, if your work relies on software libraries, or was inspired by looking at other work, it is appropriate to acknowledge this intellectual debt too.)
96+
97+
<div align="center">
98+
<br>
99+
<a href="https://www.caltech.edu">
100+
<img width="100" height="100" src=".graphics/caltech-round.png">
101+
</a>
102+
</div>

Diff for: ‎SUPPORT.md

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
Support
2+
=======
3+
4+
Thank you for your interest in this project. If you are experiencing problems or have questions, the following are the preferred methods of reaching someone:
5+
6+
1. Report a new issue using the [issue tracker](https://github.com/caltechlibrary/template/issues).
7+
2. Send email to the Caltech Library: [[email protected]](mailto:[email protected]).
8+
3. Send email to an individual involved in the project. People's names appear in the top-level `README.md` file in the source code repository.

Diff for: ‎codemeta.json

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
{
2+
"@context": "https://doi.org/10.5063/schema/codemeta-2.0",
3+
"@type": "SoftwareSourceCode",
4+
"description": "YOUR DESCRIPTION",
5+
"name": "YOUR REPOSITORY NAME",
6+
"codeRepository": "https://github.com/caltechlibrary/REPONAME",
7+
"issueTracker": "https://github.com/caltechlibrary/REPONAME/issues",
8+
"license": "https://github.com/caltechlibrary/REPONAME/blob/master/LICENSE",
9+
"version": "1.0.0",
10+
"author": [
11+
{
12+
"@type": "Person",
13+
"givenName": "FIRSTNAME",
14+
"familyName": "LASTNAME",
15+
"affiliation": "California Institute of Technology Library",
16+
"email": "EMAIL",
17+
"@id": "https://orcid.org/YOUR-ORCID"
18+
}],
19+
"developmentStatus": "active",
20+
"downloadUrl": "https://github.com/caltechlibrary/REPONAME/archive/1.0.0.zip",
21+
"keywords": [
22+
"software",
23+
],
24+
"maintainer": "https://orcid.org/YOUR-ORCID",
25+
}

0 commit comments

Comments
 (0)