Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update repo to match main template #176

Merged
merged 5 commits into from
Sep 22, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
31 changes: 31 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
name: "\U0001F41B Bug report"
about: Create a report to help us improve Stone
title: ''
labels: bug
assignees: ''

---

**Describe the bug**
A clear and concise description of the bug.

**To Reproduce**
The steps to reproduce the behavior

**Expected Behavior**
A clear description of what you expected to happen.

**Actual Behavior**
A clear description of what actually happened

**Screenshots**
If applicable, add screenshots to help explain your problem.

**Versions**
* What version of the Stone are you using?
* What version of the language are you using?
* What platform are you using? (if applicable)

**Additional context**
Add any other context about the problem here.
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
blank_issues_enabled: false
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
name: "\U0001F680 Feature Request"
about: Suggest an idea for Stone
title: ''
labels: enhancement
assignees: ''

---

**Why is this feature valuable to you? Does it solve a problem you're having?**
A clear and concise description of why this feature is valuable. Ex. I'm always frustrated when [...]

**Describe the solution you'd like**
A clear and concise description of what you want to happen.

**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered. (if applicable)

**Additional context**
Add any other context or screenshots about the feature request here.
25 changes: 25 additions & 0 deletions .github/ISSUE_TEMPLATE/question_help.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
name: "\U0001F4AC Questions / Help"
about: Get help with issues you are experiencing
title: ''
labels: help-wanted, question
assignees: ''

---

**Before you start**
Have you checked StackOverflow, previous issues, and Dropbox Developer Forums for help?

**What is your question?**
A clear and concise description the question.

**Screenshots**
If applicable, add screenshots to help explain your question.

**Versions**
* What version of Stone are you using?
* What version of the language are you using?
* What platform are you using? (if applicable)

**Additional context**
Add any other context about the question here.
16 changes: 16 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# To get started with Dependabot version updates, you'll need to specify which
# package ecosystems to update and where the package manifests are located.
# Please see the documentation for all configuration options:
# https://help.github.com/github/administering-a-repository/configuration-options-for-dependency-updates

version: 2
updates:
- package-ecosystem: "pip" # See documentation for possible values
directory: "/" # Location of package manifests
schedule:
interval: "daily"

- package-ecosystem: "github-actions"
directory: "/"
schedule:
interval: "daily"
18 changes: 18 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
<!--
Thank you for your pull request. Please provide a description below.
-->

## **Checklist**
<!-- For completed items, change [ ] to [x]. -->

**General Contributing**
- [ ] Have you read the Code of Conduct and signed the [CLA](https://opensource.dropbox.com/cla/)?

**Is This a Code Change?**
- [ ] Non-code related change (markdown/git settings etc)
- [ ] Code Change
- [ ] Example/Test Code Change

**Validation**
- [ ] Have you ran `tox`?
- [ ] Do the tests pass?
5 changes: 5 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Dropbox Code Of Conduct

*Dropbox believes that an inclusive development environment fosters greater technical achievement. To encourage a diverse group of contributors we've adopted this code of conduct.*

Please read the Official Dropbox [Code of Conduct](https://opensource.dropbox.com/coc/) before contributing.
35 changes: 35 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# Contributing to Stone
We value and rely on the feedback from our community. This comes in the form of bug reports, feature requests, and general guidance. We welcome your issues and pull requests and try our hardest to be timely in both response and resolution. Please read through this document before submitting issues or pull requests to ensure we have the necessary information to help you resolve your issue.

## Filing Bug Reports
You can file a bug report on the [GitHub Issues][issues] page.

1. Search through existing issues to ensure that your issue has not been reported. If it is a common issue, there is likely already an issue.

2. Please ensure you are using the latest version of Stone. While this may be a valid issue, we only will fix bugs affecting the latest version and your bug may have been fixed in a newer version.

3. Provide as much information as you can regarding the language version, Stone version, and any other relevant information about your environment so we can help resolve the issue as quickly as possible.

## Submitting Pull Requests

We are more than happy to receive pull requests helping us improve the state of our SDK. You can open a new pull request on the [GitHub Pull Requests][pr] page.

1. Please ensure that you have read the [License][license], [Code of Conduct][coc] and have signed the [Contributing License Agreement (CLA)][cla].

2. Please add tests confirming the new functionality works. Pull requests will not be merged without passing continuous integration tests unless the pull requests aims to fix existing issues with these tests.

## Testing the Code

Tests live under the `test/` folder. They can be run by running the following command:

```
$ python setup.py test
```

They can also be run as a part of `tox` and they should be ran in a virtual environment to ensure isolation of the testing environment.

[issues]: https://github.com/dropbox/stone/issues
[pr]: https://github.com/dropbox/stone/pulls
[coc]: https://github.com/dropbox/stone/blob/master/CODE_OF_CONDUCT.md
[license]: https://github.com/dropbox/stone/blob/master/LICENSE
[cla]: https://opensource.dropbox.com/cla/
4 changes: 2 additions & 2 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Copyright (c) 2014-2016 Dropbox Inc., http://www.dropbox.com/
Copyright (c) 2020 Dropbox Inc., http://www.dropbox.com/

Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
Expand All @@ -17,4 +17,4 @@ Copyright (c) 2014-2016 Dropbox Inc., http://www.dropbox.com/
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
99 changes: 68 additions & 31 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,11 +1,55 @@
=====
Stone
=====
.. image:: https://cfl.dropboxstatic.com/static/images/sdk/stone_banner.png
:target: https://github.com/dropbox/stone

*Warning: The documentation is undergoing a rewrite.*
.. image:: https://img.shields.io/pypi/pyversions/stone.svg
:target: https://pypi.python.org/pypi/stone

.. image:: https://img.shields.io/pypi/v/stone.svg
:target: https://pypi.python.org/pypi/stone

.. image:: https://codecov.io/gh/dropbox/stone/branch/master/graph/badge.svg
:target: https://codecov.io/gh/dropbox/stone

The Official Api Spec Language for Dropbox.

`Documentation`_ can be found on GitHub

Installation
============

Install stone using ``pip``::

$ pip install --user stone

This will install a script ``stone`` to your PATH that can be run from the
command line::

$ stone -h

Alternative
-----------

If you choose not to install ``stone`` using the method above, you will need
to ensure that you have the Python packages ``ply`` and ``six``, which can be
installed through ``pip``::

$ pip install "ply>=3.4" "six>=1.3.0" "typing>=3.5.2"

If the ``stone`` package is in your PYTHONPATH, you can replace ``stone``
with ``python -m stone.cli`` as follows::

$ python -m stone.cli -h

If you have the ``stone`` package on your machine, but did not install it or
add its location to your PYTHONPATH, you can use the following::

$ PYTHONPATH=path/to/stone python -m stone.cli -h

After installation, follow one of our `Examples`_ or read the `Documentation`_.

.. image:: https://travis-ci.org/dropbox/stone.svg?branch=master
:target: https://travis-ci.org/dropbox/stone

Overview
========

Define an API once in Stone. Use backends, i.e. code generators, to translate
your specification into objects and functions in the programming languages of
Expand All @@ -22,8 +66,7 @@ your choice.
* `JSON Serializer <https://github.com/dropbox/stone/blob/master/docs/json_serializer.rst>`_
* `Network Protocol <https://github.com/dropbox/stone/blob/master/docs/network_protocol.rst>`_

Overview
========
*Warning: The documentation is undergoing a rewrite.*

.. image:: docs/overview.png

Expand Down Expand Up @@ -119,33 +162,27 @@ result types defined without relation to each other. In other words, the
type of response does not change based on the input to the endpoint. An
exception to this rule is afforded for error responses.

Installation
============

Install stone using ``pip``::

$ pip install --user stone

This will install a script ``stone`` to your PATH that can be run from the
command line::

$ stone -h
Examples
========

Alternative
-----------
We provide `Examples`_ to help get you started with a lot of the basic functionality of Stone.

If you choose not to install ``stone`` using the method above, you will need
to ensure that you have the Python packages ``ply`` and ``six``, which can be
installed through ``pip``::
Getting Help
============

$ pip install "ply>=3.4" "six>=1.3.0" "typing>=3.5.2"
If you find a bug, please see `CONTRIBUTING.md`_ for information on how to report it.

If the ``stone`` package is in your PYTHONPATH, you can replace ``stone``
with ``python -m stone.cli`` as follows::
If you need help that is not specific to Stone, please reach out to `Dropbox Support`_.

$ python -m stone.cli -h
License
=======

If you have the ``stone`` package on your machine, but did not install it or
add its location to your PYTHONPATH, you can use the following::
Stone is distributed under the MIT license, please see `LICENSE`_ for more information.

$ PYTHONPATH=path/to/stone python -m stone.cli -h
.. _logo: {logo_link}
.. _repo: https://github.com/dropbox/stone
.. _`Documentation`: https://github.com/dropbox/stone/tree/master/docs
.. _`Examples`: https://github.com/dropbox/stone/tree/master/example/backend
.. _LICENSE: https://github.com/dropbox/stone/blob/master/LICENSE
.. _CONTRIBUTING.md: https://github.com/dropbox/stone/blob/master/CONTRIBUTING.md
.. _`Dropbox Support`: https://www.dropbox.com/developers/contact