bugfixes found during release (#5)

* fixing urls in readme

* fixing workflow badges

* re-enabling the slack notifications

* working on sdist build

* proper files included in sdist

* adding ref to conda channel

* added citation info

* added action for pypi

* updating citation

* renaming some workflows

* updating docker address

* changing conda package name

* removing build demo

* demo app only deployed with pushes to develop-ui

* added tip to docs

* syntax fix

.github/workflows/push_to_s3.yml

@@ -23,7 +23,6 @@ name: push-to-s3
 on:
     push:
         branches:
-            - develop
             - develop-ui
 
 jobs:

.github/workflows/pypi.yml

@@ -0,0 +1,48 @@
+# Copyright 2021 Agnostiq Inc.
+#
+# This file is part of Covalent.
+# 
+# Licensed under the GNU Affero General Public License 3.0 (the "License"). 
+# A copy of the License may be obtained with this software package or at
+#
+#      https://www.gnu.org/licenses/agpl-3.0.en.html
+#
+# Use of this file is prohibited except in compliance with the License. Any 
+# modifications or derivative works of this file must retain this copyright 
+# notice, and modified files must contain a notice indicating that they have 
+# been altered from the originals.
+#
+# Covalent is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+# FITNESS FOR A PARTICULAR PURPOSE. See the License for more details.
+#
+# Relief from the License may be granted by purchasing a commercial license.
+
+name: pypi
+
+on:
+  push:
+    branches:
+      - master
+
+jobs:
+  pypi:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out master
+        uses: actions/checkout@v2
+      - name: Set up Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: 3.8
+      - name: Install Python dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install twine
+      - name: Build Distribution
+        run: python setup.py sdist
+      - name: Upload Distribution
+        env:
+          TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }}
+          TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
+        run: twine upload sdist/*

.github/workflows/tests.yml

@@ -29,14 +29,14 @@ jobs:
   tests:
     runs-on: ubuntu-latest
     steps:
-#      - name: Start notification
-#        uses: rtCamp/action-slack-notify@v2
-#        env:
-#          SLACK_CHANNEL: "covalent-ci"
-#          SLACK_USERNAME: "CovalentOpsBot"
-#          SLACK_MESSAGE: "Test started by push."
-#          SLACK_WEBHOOK: ${{ secrets.SLACK_WEBHOOK }}
-#          SLACK_COLOR: "#808080"
+      - name: Start notification
+        uses: rtCamp/action-slack-notify@v2
+        env:
+          SLACK_CHANNEL: "covalent-ci"
+          SLACK_USERNAME: "CovalentOpsBot"
+          SLACK_MESSAGE: "Test started by push."
+          SLACK_WEBHOOK: ${{ secrets.SLACK_WEBHOOK }}
+          SLACK_COLOR: "#808080"
       - name: Check out head
         uses: actions/checkout@v2
         with:
@@ -56,24 +56,24 @@ jobs:
         run: covalent start -d
       - name: Run tests and measure coverage
         run: pytest -v --cov=covalent --cov=covalent_dispatcher
-#      - name: Notify success
-#        if: success()
-#        uses: rtCamp/action-slack-notify@v2
-#        env:
-#          SLACK_CHANNEL: "covalent-ci"
-#          SLACK_USERNAME: "CovalentOpsBot"
-#          SLACK_MESSAGE: "Test succeeded."
-#          SLACK_WEBHOOK: ${{ secrets.SLACK_WEBHOOK }}
-#          SLACK_COLOR: ${{ job.status }}
-#      - name: Notify failure
-#        if: failure()
-#        uses: rtCamp/action-slack-notify@v2
-#        env:
-#          SLACK_CHANNEL: "covalent-ci"
-#          SLACK_USERNAME: "CovalentOpsBot"
-#          SLACK_MESSAGE: "Test failed."
-#          SLACK_WEBHOOK: ${{ secrets.SLACK_WEBHOOK }}
-#          SLACK_COLOR: ${{ job.status }}
+      - name: Notify success
+        if: success()
+        uses: rtCamp/action-slack-notify@v2
+        env:
+          SLACK_CHANNEL: "covalent-ci"
+          SLACK_USERNAME: "CovalentOpsBot"
+          SLACK_MESSAGE: "Test succeeded."
+          SLACK_WEBHOOK: ${{ secrets.SLACK_WEBHOOK }}
+          SLACK_COLOR: ${{ job.status }}
+      - name: Notify failure
+        if: failure()
+        uses: rtCamp/action-slack-notify@v2
+        env:
+          SLACK_CHANNEL: "covalent-ci"
+          SLACK_USERNAME: "CovalentOpsBot"
+          SLACK_MESSAGE: "Test failed."
+          SLACK_WEBHOOK: ${{ secrets.SLACK_WEBHOOK }}
+          SLACK_COLOR: ${{ job.status }}
       - name: Generate coverage report
         run: coverage xml
       - name: Upload report to Codecov
@@ -89,17 +89,17 @@ jobs:
           git remote set-url origin https://${{ secrets.COVALENT_OPS_BOT_TOKEN }}@github.com/AgnostiqHQ/covalent.git
           git fetch --unshallow
           git push origin HEAD:master
-#      - name: Format Slack message
-#        if: github.ref == 'refs/heads/develop'
-#        run: |
-#          VERSION="$(cat ./VERSION)"
-#          SLACK_MSG=":rocket: Version $VERSION is now available."
-#          echo "SLACK_MSG=$SLACK_MSG" >> $GITHUB_ENV
-#      - name: Notify Slack
-#        if: github.ref == 'refs/heads/develop'
-#        uses: rtCamp/action-slack-notify@v2
-#        env:
-#          SLACK_CHANNEL: "covalent-ci"
-#          SLACK_USERNAME: "CovalentOpsBot"
-#          SLACK_MESSAGE: ${{ env.SLACK_MSG }}
-#          SLACK_WEBHOOK: ${{ secrets.SLACK_WEBHOOK }}
+      - name: Format Slack message
+        if: github.ref == 'refs/heads/develop'
+        run: |
+          VERSION="$(cat ./VERSION)"
+          SLACK_MSG=":rocket: Version $VERSION is now available."
+          echo "SLACK_MSG=$SLACK_MSG" >> $GITHUB_ENV
+      - name: Notify Slack
+        if: github.ref == 'refs/heads/develop'
+        uses: rtCamp/action-slack-notify@v2
+        env:
+          SLACK_CHANNEL: "covalent-ci"
+          SLACK_USERNAME: "CovalentOpsBot"
+          SLACK_MESSAGE: ${{ env.SLACK_MSG }}
+          SLACK_WEBHOOK: ${{ secrets.SLACK_WEBHOOK }}

.github/workflows/version.yml

@@ -82,12 +82,12 @@ jobs:
           else
             echo "Pass due to bad version format in develop branch."
           fi
-#      - name: Notify failure
-#        if: failure()
-#        uses: rtCamp/action-slack-notify@v2
-#        env:
-#          SLACK_CHANNEL: "covalent-ci"
-#          SLACK_USERNAME: "CovalentOpsBot"
-#          SLACK_MESSAGE: "Failed to validate version or changelog."
-#          SLACK_WEBHOOK: ${{ secrets.SLACK_WEBHOOK }}
-#          SLACK_COLOR: ${{ job.status }}
+      - name: Notify failure
+        if: failure()
+        uses: rtCamp/action-slack-notify@v2
+        env:
+          SLACK_CHANNEL: "covalent-ci"
+          SLACK_USERNAME: "CovalentOpsBot"
+          SLACK_MESSAGE: "Failed to validate version or changelog."
+          SLACK_WEBHOOK: ${{ secrets.SLACK_WEBHOOK }}
+          SLACK_COLOR: ${{ job.status }}

.gitignore

@@ -18,7 +18,7 @@
 #
 # Relief from the License may be granted by purchasing a commercial license.
 
-# Ignore results folderss
+# Ignore results folders
 **/results/**
 **/result_*
 !covalent_ui/result_webhook.py

CHANGELOG.md

@@ -5,6 +5,21 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.22.1] - 2022-01-25
+
+### Added
+
+- Code of conduct
+- Manifest.in file
+- Citation info
+- Action to upload to pypi
+
+### Fixed
+
+- Absolute URLs used in README
+- Workflow badges updated URLs
+- `install_package_data` -> `include_package_data` in `setup.py`
+
 ## [0.22.0] - 2022-01-25
 
 ### Changed

CODE_OF_CONDUCT.md

@@ -0,0 +1,78 @@
+
+# Code of Conduct
+
+## Our Pledge
+
+The Covalent community is committed to ensuring that every interested individual is empowered to participate in this project fully and safely. All participants, including attendees, speakers, sponsors, volunteers, and online contributors are expected to adhere to this pledge. We as members, contributors, and leaders pledge to make Covalent a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community while engaging online and offline.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+* Practicing blameless engineering and treating technical issues as opportunities for learning and improvement
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders 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, and will communicate reasons for moderation decisions when appropriate.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at [[email protected]](mailto:[email protected]). All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org/), version [2.1](https://www.contributor-covenant.org/version/2/1/code_of_conduct.html).
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://www.mozilla.org/en-US/about/governance/policies/participation/).
+
+Additional concepts and language are adapted from the [Qiskit Code of Conduct](https://github.com/Qiskit/qiskit/blob/master/CODE_OF_CONDUCT.md)

MANIFEST.in

@@ -0,0 +1,2 @@
+include VERSION
+include requirements.txt

README.md

@@ -1,15 +1,15 @@
  
 
 <div align="center">
-<img src="doc/source/_static/light.png#gh-light-mode-only" width="70%">
-<img src="doc/source/_static/dark.png#gh-dark-mode-only" width="70%">
+<img src="https://github.com/AgnostiqHQ/covalent/blob/master/doc/source/_static/light.png#gh-light-mode-only" width="70%">
+<img src="https://github.com/AgnostiqHQ/covalent/blob/master/doc/source/_static/dark.png#gh-dark-mode-only" width="70%">
 
 &nbsp;
 
 [![version](https://github-covalent-badges.s3.amazonaws.com/badges/version.svg?maxAge=3600)](https://github.com/AgnostiqHQ/covalent)
 [![python](https://img.shields.io/badge/python-3.8-blue.svg)](https://www.python.org/downloads/release/python-380)
-[![tests](https://github.com/AgnostiqHQ/covalent/actions/workflows/tests.yml/badge.svg)](https://github.com/AgnostiqHQ/covalent/actions)
-[![publish](https://github.com/AgnostiqHQ/covalent/actions/workflows/publish.yml/badge.svg)](https://github.com/AgnostiqHQ/covalent/actions)
+[![tests](https://github.com/AgnostiqHQ/covalent/actions/workflows/tests.yml/badge.svg)](https://github.com/AgnostiqHQ/covalent/actions/workflows/tests.yml)
+[![publish](https://github.com/AgnostiqHQ/covalent/actions/workflows/publish_master.yml/badge.svg)](https://github.com/AgnostiqHQ/covalent/actions/workflows/publish_master.yml)
 [![docs](https://readthedocs.org/projects/covalent/badge/?version=latest)](https://covalent.readthedocs.io/en/latest/?badge=latest)
 [![codecov](https://codecov.io/gh/AgnostiqHQ/covalent/branch/master/graph/badge.svg?token=YGHCB3DE4P)](https://codecov.io/gh/AgnostiqHQ/covalent)
 [![agpl](https://img.shields.io/badge/License-AGPL_v3-blue.svg)](https://www.gnu.org/licenses/agpl-3.0.en.html)
@@ -23,7 +23,7 @@ Covalent is a Pythonic workflow tool used to execute tasks on advanced computing
 ## ✨ Features
 
 <div align="center">
-<img src="doc/source/_static/uibanner.png" width="100%">
+<img src="https://github.com/AgnostiqHQ/covalent/blob/master/doc/source/_static/uibanner.png" width="100%">
 
 <em>With Covalent's UI, bring your workflows to life! </em>
 </div>
@@ -194,12 +194,19 @@ The official documentation includes tips on getting started, some high level con
 
 ## ✔️  Contributing
 
-To contribute to Covalent, refer to the [Contribution Guidelines](./CONTRIBUTING.md). We use GitHub's [issue tracking](https://github.com/AgnostiqHQ/covalent/issues) to manage known issues, bugs, and pull requests. Get started by forking the develop branch and submitting a pull request with your contributions. Improvements to the documentation, including tutorials and how-to guides, are also welcome from the community. Participation in the Covalent community is governed by the [Code of Conduct](./CODE_OF_CONDUCT.md).
+To contribute to Covalent, refer to the [Contribution Guidelines](https://github.com/AgnostiqHQ/covalent/blob/master/CONTRIBUTING.md). We use GitHub's [issue tracking](https://github.com/AgnostiqHQ/covalent/issues) to manage known issues, bugs, and pull requests. Get started by forking the develop branch and submitting a pull request with your contributions. Improvements to the documentation, including tutorials and how-to guides, are also welcome from the community. Participation in the Covalent community is governed by the [Code of Conduct](https://github.com/AgnostiqHQ/covalent/blob/master/CODE_OF_CONDUCT.md).
 
 ## 📝 Release Notes
 
-Release notes are available in the [Changelog](./CHANGELOG.md).
+Release notes are available in the [Changelog](https://github.com/AgnostiqHQ/covalent/blob/master/CHANGELOG.md).
+
+## ⚓ Citation
+
+Please use the following citation in any publications:
+
+> W. J. Cunningham, S. K. Radha, F. Hasan, J. Kanem, S. W. Neagle, and S. Sanand.
+> *Covalent.* Zenodo, 2022. https://doi.org/10.5281/zenodo.5903364
 
 ## 📃 License
 
-Covalent is licensed under the GNU Affero GPL 3.0 License. Covalent may be distributed under other licenses upon request. See the [LICENSE](LICENSE) file or contact the [support team](mailto:[email protected]) for more details.
+Covalent is licensed under the GNU Affero GPL 3.0 License. Covalent may be distributed under other licenses upon request. See the [LICENSE](https://github.com/AgnostiqHQ/covalent/blob/master/LICENSE) file or contact the [support team](mailto:[email protected]) for more details.

VERSION

@@ -1 +1 @@
-0.22.0
+0.22.1