Skip to content

Commit 0d6bb97

Browse files
beckynevinSQuaRE Bot
beckynevin
authored and
SQuaRE Bot
committed
Initial commit
0 parents  commit 0d6bb97

File tree

16 files changed

+879
-0
lines changed

16 files changed

+879
-0
lines changed

‎.github/workflows/lint.yaml

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
name: lint
2+
3+
on:
4+
- push
5+
- pull_request
6+
7+
jobs:
8+
lint:
9+
runs-on: ubuntu-latest
10+
steps:
11+
- uses: actions/checkout@v2
12+
13+
- name: Set up Python
14+
uses: actions/setup-python@v2
15+
with:
16+
python-version: 3.7
17+
18+
- name: Install
19+
run: pip install -r <(curl https://raw.githubusercontent.com/lsst/linting/main/requirements.txt)
20+
21+
- name: Run linter
22+
run: flake8

‎.gitignore

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
.sconsign.dblite
2+
config.log
3+
.sconf_temp
4+
*.o
5+
*.os
6+
*.so
7+
*.cfgc
8+
*.pyc
9+
*_wrap.cc
10+
*Lib.py
11+
12+
# Built by sconsUtils
13+
version.py
14+
bin/
15+
16+
# Pytest
17+
tests/.tests
18+
pytest_session.txt
19+
.cache/
20+
.pytest_cache
21+
.coverage

‎COPYRIGHT

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Copyright 2023 Fermi Research Alliance, LLC

‎LICENSE

+674
Large diffs are not rendered by default.

‎README.rst

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
################
2+
transfer_embargo
3+
################
4+
5+
``transfer_embargo`` is a package in the `LSST Science Pipelines <https://pipelines.lsst.io>`_.
6+
7+
.. Add a brief (few sentence) description of what this package provides.

‎SConstruct

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# -*- python -*-
2+
from lsst.sconsUtils import scripts
3+
# Python-only package
4+
scripts.BasicSConstruct("transfer_embargo", disableCc=True, noCfgFile=True)

‎bin.src/SConscript

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# -*- python -*-
2+
from lsst.sconsUtils import scripts
3+
scripts.BasicSConscript.shebang()

‎doc/.gitignore

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# Doxygen products
2+
html
3+
xml
4+
*.tag
5+
*.inc
6+
doxygen.conf
7+
8+
# Sphinx products
9+
_build
10+
py-api

‎doc/conf.py

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
"""Sphinx configuration file for an LSST stack package.
2+
3+
This configuration only affects single-package Sphinx documentation builds.
4+
For more information, see:
5+
https://developer.lsst.io/stack/building-single-package-docs.html
6+
"""
7+
8+
from documenteer.conf.pipelinespkg import *
9+
10+
11+
project = "transfer_embargo"
12+
html_theme_options["logotext"] = project
13+
html_title = project
14+
html_short_title = project

‎doc/index.rst

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
######################################
2+
transfer_embargo documentation preview
3+
######################################
4+
5+
.. This page is for local development only. It isn't published to pipelines.lsst.io.
6+
7+
.. Link the index pages of package and module documentation directions (listed in manifest.yaml).
8+
9+
.. toctree::
10+
:maxdepth: 1
11+
12+
lsst.transfer.embargo/index

‎doc/lsst.transfer.embargo/index.rst

+51
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
.. py:currentmodule:: lsst.transfer.embargo
2+
3+
.. _lsst.transfer.embargo:
4+
5+
#####################
6+
lsst.transfer.embargo
7+
#####################
8+
9+
.. Paragraph that describes what this Python module does and links to related modules and frameworks.
10+
11+
.. .. _lsst.transfer.embargo-using:
12+
13+
.. Using lsst.transfer.embargo
14+
.. ===========================
15+
16+
.. toctree linking to topics related to using the module's APIs.
17+
18+
.. .. toctree::
19+
.. :maxdepth: 1
20+
21+
.. _lsst.transfer.embargo-contributing:
22+
23+
Contributing
24+
============
25+
26+
``lsst.transfer.embargo`` is developed at https://github.com/lsst-dm/transfer_embargo.
27+
You can find Jira issues for this module under the `transfer_embargo <https://jira.lsstcorp.org/issues/?jql=project%20%3D%20DM%20AND%20component%20%3D%20transfer_embargo>`_ component.
28+
29+
.. If there are topics related to developing this module (rather than using it), link to this from a toctree placed here.
30+
31+
.. .. toctree::
32+
.. :maxdepth: 1
33+
34+
.. .. _lsst.transfer.embargo-scripts:
35+
36+
.. Script reference
37+
.. ================
38+
39+
.. .. TODO: Add an item to this toctree for each script reference topic in the scripts subdirectory.
40+
41+
.. .. toctree::
42+
.. :maxdepth: 1
43+
44+
.. .. _lsst.transfer.embargo-pyapi:
45+
46+
Python API reference
47+
====================
48+
49+
.. automodapi:: lsst.transfer.embargo
50+
:no-main-docstr:
51+
:no-inheritance-diagram:

‎doc/manifest.yaml

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# Documentation manifest.
2+
3+
# List of names of Python modules in this package.
4+
# For each module there is a corresponding module doc subdirectory.
5+
modules:
6+
- "lsst.transfer.embargo"
7+
8+
# Name of the static content directories (subdirectories of `_static`).
9+
# Static content directories are usually named after the package.
10+
# Most packages do not need a static content directory (leave commented out).
11+
# statics:
12+
# - "_static/transfer_embargo"

‎python/lsst/transfer/embargo/__init__.py

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# This file is part of transfer_embargo.
2+
#
3+
# Developed for the LSST Data Management System.
4+
# This product includes software developed by the LSST Project
5+
# (https://www.lsst.org).
6+
# See the COPYRIGHT file at the top-level directory of this distribution
7+
# for details of code ownership.
8+
#
9+
# This program is free software: you can redistribute it and/or modify
10+
# it under the terms of the GNU General Public License as published by
11+
# the Free Software Foundation, either version 3 of the License, or
12+
# (at your option) any later version.
13+
#
14+
# This program is distributed in the hope that it will be useful,
15+
# but WITHOUT ANY WARRANTY; without even the implied warranty of
16+
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17+
# GNU General Public License for more details.
18+
#
19+
# You should have received a copy of the GNU General Public License
20+
# along with this program. If not, see <https://www.gnu.org/licenses/>.
21+
22+
from .version import * # Generated by sconsUtils

‎setup.cfg

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
[flake8]
2+
max-line-length = 110
3+
max-doc-length = 79
4+
ignore = E133, E226, E228, N802, N803, N806, N812, N813, N815, N816, W503
5+
exclude =
6+
bin,
7+
doc/conf.py,
8+
**/*/__init__.py,
9+
**/*/version.py,
10+
tests/.tests
11+
12+
[tool:pytest]
13+
addopts = --flake8
14+
flake8-ignore = E133 E226 E228 N802 N803 N806 N812 N813 N815 N816 W503

‎tests/SConscript

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# -*- python -*-
2+
from lsst.sconsUtils import scripts
3+
scripts.BasicSConscript.tests(pyList=[])

‎ups/transfer_embargo.table

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# List EUPS dependencies of this package here.
2+
# - Any package whose API is used directly should be listed explicitly.
3+
# - Common third-party packages can be assumed to be recursively included by
4+
# the "base" package.
5+
setupRequired(base)
6+
7+
# The following is boilerplate for all packages.
8+
# See https://dmtn-001.lsst.io for details on LSST_LIBRARY_PATH.
9+
envPrepend(PYTHONPATH, ${PRODUCT_DIR}/python)

0 commit comments

Comments
 (0)