encode/django-rest-framework
1
1
Fork 0
mirror of https://github.com/encode/django-rest-framework.git synced 2024-11-25 19:14:01 +03:00
Code Issues Packages Projects Releases Wiki Activity

Funding announcement (#4147)

Browse Source
This commit is contained in:
Tom Christie 2016-05-26 11:48:15 +01:00
parent 592eea9b9e
commit 3a173547ad
6 changed files with 189 additions and 76 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
docs/index.md
View File

@ -204,6 +204,8 @@ General guides to using REST framework.
* [3.2 Announcement][3.2-announcement] * [3.2 Announcement][3.2-announcement]
* [3.3 Announcement][3.3-announcement] * [3.3 Announcement][3.3-announcement]
* [Kickstarter Announcement][kickstarter-announcement] * [Kickstarter Announcement][kickstarter-announcement]
* [Mozilla Grant][mozilla-grant]
* [Funding][funding]
* [Release Notes][release-notes] * [Release Notes][release-notes]
## Development ## Development
@ -320,6 +322,7 @@ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
[3.2-announcement]: topics/3.2-announcement.md [3.2-announcement]: topics/3.2-announcement.md
[3.3-announcement]: topics/3.3-announcement.md [3.3-announcement]: topics/3.3-announcement.md
[kickstarter-announcement]: topics/kickstarter-announcement.md [kickstarter-announcement]: topics/kickstarter-announcement.md
[mozilla-grant]: topics/mozilla-grant.md
[funding]: topics/funding.md [funding]: topics/funding.md
[release-notes]: topics/release-notes.md [release-notes]: topics/release-notes.md

167
docs/topics/funding.md
View File

@ -8,6 +8,22 @@ if (window.location.hostname == "www.django-rest-framework.org") {
</script> </script>
<style> <style>
.promo li a {
float: left;
width: 130px;
height: 20px;
text-align: center;
margin: 10px 30px;
padding: 150px 0 0 0;
background-position: 0 50%;
background-size: 130px auto;
background-repeat: no-repeat;
font-size: 120%;
color: black;
}
.promo li {
list-style: none;
}
.chart { .chart {
background-color: #e3e3e3; background-color: #e3e3e3;
background: -webkit-linear-gradient(top, #fff 0, #e3e3e3 100%); background: -webkit-linear-gradient(top, #fff 0, #e3e3e3 100%);
@ -47,9 +63,11 @@ if (window.location.hostname == "www.django-rest-framework.org") {
margin: 0 auto; margin: 0 auto;
margin-top: 8px; } margin-top: 8px; }
.specs { .specs {
margin-top: 20px; } margin-top: 20px; min-height: 130px;
.specs.startup { }
margin-bottom: 93px } .specs.freelancer {
min-height: 0px;
}
.spec { .spec {
font-size: 15px; font-size: 15px;
color: #474747; color: #474747;
@ -79,27 +97,32 @@ form.signup {
# Funding # Funding
> As a direct result of [a successful Mozilla grant application](mozilla-grant.md), I will be leaving my current role at [DabApps](http://www.dabapps.com), and attempting to secure a sustainable business model for REST framework development. I need your help in order to make this work.
>
> &mdash; Tom Christie
If you use REST framework commercially we strongly encourage you to invest in its continued development by signing up for a paid plan. If you use REST framework commercially we strongly encourage you to invest in its continued development by signing up for a paid plan.
**We believe that collaboratively funded software can offer outstanding returns on investment, by allowing users and clients to collectively share the cost of development.** **We believe that collaboratively funded software can offer outstanding returns on investment, by encouraging our users to collectively share the cost of development.**
Signing up for a paid plan will: Signing up for a paid plan will:
* Directly contribute to faster releases, more features and higher quality software. * Directly contribute to faster releases, more features, and higher quality software.
* Allow more time to be invested in documentation, issue triage and community support. * Allow more time to be invested in documentation, issue triage, and community support.
* Safeguard the future development of REST framework. * Safeguard the future development of REST framework.
REST framework will always be open source and permissively licensed, but we firmly believe it is in the commercial best-interest for users of the project to fund its ongoing development. REST framework continues to be open-source and permissively licensed, but we firmly believe it is in the commercial best-interest for users of the project to invest in its ongoing development.
--- ---
## Making the business case ## Making the business case
Our successful Kickstarter campaign demonstrates the cost-reward ratio of shared development funding. Our [successful Kickstarter campaign](https://www.kickstarter.com/projects/tomchristie/django-rest-framework-3) demonstrates the impressive cost-reward ratio of shared funding of open-source software.
With *typical corporate fundings of just £100-£1000 per organization* we successfully delivered: With *typical corporate fundings of just £100-£1000 per organization* we successfully delivered:
* The comprehensive 3.0 serializer redesign. * The comprehensive serializer redesign, and **version 3.0 release**.
* Ongoing triage and community support, **closing over 1600 tickets**.
* Substantial improvements to the Browsable API. * Substantial improvements to the Browsable API.
* The admin interface. * The admin interface.
* A new pagination API including offset/limit and cursor pagination implementations, plus on-page controls. * A new pagination API including offset/limit and cursor pagination implementations, plus on-page controls.
@ -110,13 +133,14 @@ With *typical corporate fundings of just £100-£1000 per organization* we succe
* Internationalization support for API responses, currently with 27 languages. * Internationalization support for API responses, currently with 27 languages.
* The metadata APIs for handling `OPTIONS` requests and schema endpoints. * The metadata APIs for handling `OPTIONS` requests and schema endpoints.
* Numerous minor improvements and better quality throughout the codebase. * Numerous minor improvements and better quality throughout the codebase.
* Ongoing triage and community support, closing over 1600 tickets.
This incredible level of return on investment is *only possible through collaboratively funded models*, which is why we believe that supporting our paid plans is in everyone's best interest. This incredible level of return on investment is *only possible through collaboratively funded models*, which is why we believe that supporting our paid plans is in everyone's best interest.
Sign up for a paid plan today, and help ensure that REST framework becomes a sustainable, full-time funded project.
--- ---
## Individual plan ## Freelancer plan
This subscription is recommended for freelancers and other individuals with an interest in seeing REST framework continue to&nbsp;improve. This subscription is recommended for freelancers and other individuals with an interest in seeing REST framework continue to&nbsp;improve.
@ -126,12 +150,12 @@ If you are using REST framework as an full-time employee, consider recommending
<div class="span4"> <div class="span4">
<div class="chart first"> <div class="chart first">
<div class="quantity"> <div class="quantity">
<span class="dollar">$</span> <span class="dollar">{{ symbol }}</span>
<span class="price">15</span> <span class="price">{{ rates.personal1 }}</span>
<span class="period">/month</span> <span class="period">/month{% if vat %} +VAT{% endif %}</span>
</div> </div>
<div class="plan-name">Individual</div> <div class="plan-name">Freelancer</div>
<div class="specs"> <div class="specs freelancer">
<div class="spec"> <div class="spec">
Support ongoing development Support ongoing development
</div> </div>
@ -143,10 +167,10 @@ If you are using REST framework as an full-time employee, consider recommending
<script <script
src="https://checkout.stripe.com/checkout.js" class="stripe-button" src="https://checkout.stripe.com/checkout.js" class="stripe-button"
data-key="{{ stripe_public }}" data-key="{{ stripe_public }}"
data-amount="1500" data-amount="{{ stripe_amounts.personal1 }}"
data-name="Django REST framework" data-name="Django REST framework"
data-description="Individual" data-description="Individual"
data-currency="usd" data-currency="{{ currency }}"
data-allow-remember-me=false data-allow-remember-me=false
data-billing-address=true data-billing-address=true
data-label='Sign up' data-label='Sign up'
@ -174,9 +198,9 @@ Our professional and premium plans also include **priority support**. At any tim
<div class="span4"> <div class="span4">
<div class="chart first"> <div class="chart first">
<div class="quantity"> <div class="quantity">
<span class="dollar">$</span> <span class="dollar">{{ symbol }}</span>
<span class="price">50</span> <span class="price">{{ rates.corporate1 }}</span>
<span class="period">/month</span> <span class="period">/month{% if vat %} +VAT{% endif %}</span>
</div> </div>
<div class="plan-name">Basic</div> <div class="plan-name">Basic</div>
<div class="specs startup"> <div class="specs startup">
@ -191,10 +215,10 @@ Our professional and premium plans also include **priority support**. At any tim
<script <script
src="https://checkout.stripe.com/checkout.js" class="stripe-button" src="https://checkout.stripe.com/checkout.js" class="stripe-button"
data-key="{{ stripe_public }}" data-key="{{ stripe_public }}"
data-amount="5000" data-amount="{{ stripe_amounts.corporate1 }}"
data-name="Django REST framework" data-name="Django REST framework"
data-description="Basic" data-description="Basic"
data-currency="usd" data-currency="{{ currency }}"
data-allow-remember-me=false data-allow-remember-me=false
data-billing-address=true data-billing-address=true
data-label='Sign up' data-label='Sign up'
@ -206,17 +230,17 @@ Our professional and premium plans also include **priority support**. At any tim
<div class="span4"> <div class="span4">
<div class="chart"> <div class="chart">
<div class="quantity"> <div class="quantity">
<span class="dollar">$</span> <span class="dollar">{{ symbol }}</span>
<span class="price">250</span> <span class="price">{{ rates.corporate2 }}</span>
<span class="period">/month</span> <span class="period">/month{% if vat %} +VAT{% endif %}</span>
</div> </div>
<div class="plan-name">Professional</div> <div class="plan-name">Professional</div>
<div class="specs"> <div class="specs">
<div class="spec"> <div class="spec">
Add a <span class="variable">half day per&nbsp;month</span> development time to the project Support ongoing development
</div> </div>
<div class="spec"> <div class="spec">
<span class="variable">Homepage</span> ad placement <span class="variable">Sidebar</span> ad placement
</div> </div>
<div class="spec"> <div class="spec">
<span class="variable">Priority support</span> for your engineers <span class="variable">Priority support</span> for your engineers
@ -226,10 +250,10 @@ Our professional and premium plans also include **priority support**. At any tim
<script <script
src="https://checkout.stripe.com/checkout.js" class="stripe-button" src="https://checkout.stripe.com/checkout.js" class="stripe-button"
data-key="{{ stripe_public }}" data-key="{{ stripe_public }}"
data-amount="25000" data-amount="{{ stripe_amounts.corporate2 }}"
data-name="Django REST framework" data-name="Django REST framework"
data-description="Professional" data-description="Professional"
data-currency="usd" data-currency="{{ currency }}"
data-allow-remember-me=false data-allow-remember-me=false
data-billing-address=true data-billing-address=true
data-label='Sign up' data-label='Sign up'
@ -241,17 +265,20 @@ Our professional and premium plans also include **priority support**. At any tim
<div class="span4"> <div class="span4">
<div class="chart last"> <div class="chart last">
<div class="quantity"> <div class="quantity">
<span class="dollar">$</span> <span class="dollar">{{ symbol }}</span>
<span class="price">500</span> <span class="price">{{ rates.corporate3 }}</span>
<span class="period">/month</span> <span class="period">/month{% if vat %} +VAT{% endif %}</span>
</div> </div>
<div class="plan-name">Premium</div> <div class="plan-name">Premium</div>
<div class="specs"> <div class="specs">
<div class="spec"> <div class="spec">
Add <span class="variable">one full day per&nbsp;month</span> development time to the project Support ongoing development
</div> </div>
<div class="spec"> <div class="spec">
<span class="variable">Full site</span> ad placement <span class="variable">Homepage</span> ad placement
</div>
<div class="spec">
<span class="variable">Sidebar</span> ad placement
</div> </div>
<div class="spec"> <div class="spec">
<span class="variable">Priority support</span> for your engineers <span class="variable">Priority support</span> for your engineers
@ -261,10 +288,10 @@ Our professional and premium plans also include **priority support**. At any tim
<script <script
src="https://checkout.stripe.com/checkout.js" class="stripe-button" src="https://checkout.stripe.com/checkout.js" class="stripe-button"
data-key="{{ stripe_public }}" data-key="{{ stripe_public }}"
data-amount="50000" data-amount="{{ stripe_amounts.corporate3 }}"
data-name="Django REST framework" data-name="Django REST framework"
data-description="Premium" data-description="Premium"
data-currency="usd" data-currency="{{ currency }}"
data-allow-remember-me=false data-allow-remember-me=false
data-billing-address=true data-billing-address=true
data-label='Sign up' data-label='Sign up'
@ -279,36 +306,54 @@ Our professional and premium plans also include **priority support**. At any tim
*Billing is monthly and you can cancel at any time.* *Billing is monthly and you can cancel at any time.*
Once you've signed up we'll contact you via email and arrange your ad placements on the site. Once you've signed up I'll contact you via email and arrange your ad placements on the site.
For further enquires please contact <a href=mailto:tom@tomchristie.com>tom@tomchristie.com</a>. For further enquires please contact <a href=mailto:tom@tomchristie.com>tom@tomchristie.com</a>.
--- ---
## Roadmap ## Accountability
Although we're incredibly proud of REST framework in its current state we believe there is still huge scope for improvement. What we're aiming for here is a *highly polished, rock solid product*. This needs to backed up with impeccable documentation and a great third party ecosystem. In order to ensure that I can be fully focused on trying to secure a sustainable
& well-funded open source business I will be leaving my current role at [DabApps](http://www.dabapps.com)
at the end of May 2016.
The roadmap below is a broad indication of just some of the ongoing and future work we believe is important to REST framework. I have formed a UK limited company, [Encode](http://www.encode.io), which will
act as the business entity behind REST framework. I will be issuing monthly reports
from Encode on progress both towards the [Mozilla grant](mozilla-grant.md), and for development time
funded via the REST framework paid plans.
* Increasing our "bus factor" through documented organizational process & safeguards. <!-- Begin MailChimp Signup Form -->
* More time towards testing and hardening releases, with only gradual, well-documented deprecations. <link href="//cdn-images.mailchimp.com/embedcode/classic-10_7.css" rel="stylesheet" type="text/css">
* A formal policy on security backports for non-current releases. <style type="text/css">
* Continuing triage & community support. #mc_embed_signup{background:#fff; clear:left; font:14px Helvetica,Arial,sans-serif; }
* Improved project documentation, including versioned & internationalized docs. /* Add your own MailChimp form style overrides in your site stylesheet or in this style block.
* Improved third party package visibility. We recommend moving this block and the preceding CSS link to the HEAD of your HTML file. */
* Refining the admin interface, ensuring it has a fully customizable API and making it suitable as end-user facing application. </style>
* Cleaning up internal complexities including the `BrowsableAPIRenderer` and `Request` object. <div id="mc_embed_signup">
* Support for alternative backends such as SQLAlchemy. <form action="//encode.us13.list-manage.com/subscribe/post?u=b6b66bb5e4c7cb484a85c8dd7&amp;id=e382ef68ef" method="post" id="mc-embedded-subscribe-form" name="mc-embedded-subscribe-form" class="validate" target="_blank" novalidate>
* Support for non-database backed services. <div id="mc_embed_signup_scroll">
* HTTP Caching API & support for conditional database lookups. <h2>Stay up to date, with our monthly progress reports...</h2>
* Benchmarking and performance improvements. <div class="mc-field-group">
* In depth documentation on advanced usage and best practices. <label for="mce-EMAIL">Email Address </label>
* Documentation & support for integration with realtime systems. <input type="email" value="" name="EMAIL" class="required email" id="mce-EMAIL">
* Hypermedia support and client libraries. </div>
* Support for JSON schema as endpoints or `OPTIONS` responses. <div id="mce-responses" class="clear">
* API metric tools. <div class="response" id="mce-error-response" style="display:none"></div>
* Debug & logging tools. <div class="response" id="mce-success-response" style="display:none"></div>
* Third party GraphQL support. </div> <!-- real people should not fill this in and expect good things - do not remove this or risk form bot signups-->
<div style="position: absolute; left: -5000px;" aria-hidden="true"><input type="text" name="b_b6b66bb5e4c7cb484a85c8dd7_e382ef68ef" tabindex="-1" value=""></div>
<div class="clear"><input type="submit" value="Subscribe" name="subscribe" id="mc-embedded-subscribe" class="button"></div>
</div>
</form>
</div>
<script type='text/javascript' src='//s3.amazonaws.com/downloads.mailchimp.com/js/mc-validate.js'></script><script type='text/javascript'>(function($) {window.fnames = new Array(); window.ftypes = new Array();fnames[0]='EMAIL';ftypes[0]='email';fnames[1]='FNAME';ftypes[1]='text';fnames[2]='LNAME';ftypes[2]='text';}(jQuery));var $mcj = jQuery.noConflict(true);</script>
<!--End mc_embed_signup-->
By taking out a paid plan you'll be directly contributing towards making these features happen. ---
## Our sponsors
<div id="fundingInclude"></div>
<script src="https://fund.django-rest-framework.org/funding_include.js"></script>

67
docs/topics/mozilla-grant.md Normal file
View File

@ -0,0 +1,67 @@
# Mozilla Grant
We have recently been [awarded a Mozilla grant](https://blog.mozilla.org/blog/2016/04/13/mozilla-open-source-support-moss-update-q1-2016/), in order to fund the next major releases of REST framework. This work will focus on seamless client-side integration by introducing supporting client libraries that are able to dynamically interact with REST framework APIs. The framework will provide for either hypermedia or schema endpoints, which will expose the available interface for the client libraries to interact with.
Additionally, we will be building on the realtime support that Django Channels provides, supporting and documenting how to build realtime APIs with REST framework. Again, this will include supporting work in the associated client libraries, making it easier to build richly interactive applications.
The [Core API](www.coreapi.org) project will provide the foundations for our client library support, and will allow us to support interaction using a wide range of schemas and hypermedia formats. It's worth noting that these client libraries won't be tightly coupled to solely REST framework APIs either, and will be able to interact with *any* API that exposes a supported schema or hypermedia format.
Specifically, the work includes:
## Client libraries
This work will include built-in schema and hypermedia support, allowing dynamic client libraries to interact with the API. I'll also be releasing both Python and Javascript client libraries, plus a command-line client, a new tutorial section, and further documentation.
* Client library support in REST framework.
* Schema & hypermedia support for REST framework APIs.
* A test client, allowing you to write tests that emulate a client library interacting with your API.
* New tutorial sections on using client libraries to interact with REST framework APIs.
* Python client library.
* JavaScript client library.
* Command line client.
## Realtime APIs
The next goal is to build on the realtime support offered by Django Channels, adding support & documentation for building realtime API endpoints.
* Support for API subscription endpoints, using REST framework and Django Channels.
* New tutorial section on building realtime API endpoints with REST framework.
* Realtime support in the Python & Javascript client libraries.
## Accountability
In order to ensure that I can be fully focused on trying to secure a sustainable
& well-funded open source business I will be leaving my current role at [DabApps](http://www.dabapps.com)
at the end of May 2016.
I have formed a UK limited company, [Encode](http://www.encode.io), which will
act as the business entity behind REST framework. I will be issuing monthly reports
from Encode on progress both towards the Mozilla grant, and for development time
funded via the [REST framework paid plans](funding.md).
<!-- Begin MailChimp Signup Form -->
<link href="//cdn-images.mailchimp.com/embedcode/classic-10_7.css" rel="stylesheet" type="text/css">
<style type="text/css">
#mc_embed_signup{background:#fff; clear:left; font:14px Helvetica,Arial,sans-serif; }
/* Add your own MailChimp form style overrides in your site stylesheet or in this style block.
We recommend moving this block and the preceding CSS link to the HEAD of your HTML file. */
</style>
<div id="mc_embed_signup">
<form action="//encode.us13.list-manage.com/subscribe/post?u=b6b66bb5e4c7cb484a85c8dd7&amp;id=e382ef68ef" method="post" id="mc-embedded-subscribe-form" name="mc-embedded-subscribe-form" class="validate" target="_blank" novalidate>
<div id="mc_embed_signup_scroll">
<h2>Stay up to date, with our monthly progress reports...</h2>
<div class="mc-field-group">
<label for="mce-EMAIL">Email Address </label>
<input type="email" value="" name="EMAIL" class="required email" id="mce-EMAIL">
</div>
<div id="mce-responses" class="clear">
<div class="response" id="mce-error-response" style="display:none"></div>
<div class="response" id="mce-success-response" style="display:none"></div>
</div> <!-- real people should not fill this in and expect good things - do not remove this or risk form bot signups-->
<div style="position: absolute; left: -5000px;" aria-hidden="true"><input type="text" name="b_b6b66bb5e4c7cb484a85c8dd7_e382ef68ef" tabindex="-1" value=""></div>
<div class="clear"><input type="submit" value="Subscribe" name="subscribe" id="mc-embedded-subscribe" class="button"></div>
</div>
</form>
</div>
<script type='text/javascript' src='//s3.amazonaws.com/downloads.mailchimp.com/js/mc-validate.js'></script><script type='text/javascript'>(function($) {window.fnames = new Array(); window.ftypes = new Array();fnames[0]='EMAIL';ftypes[0]='email';fnames[1]='FNAME';ftypes[1]='text';fnames[2]='LNAME';ftypes[2]='text';}(jQuery));var $mcj = jQuery.noConflict(true);</script>
<!--End mc_embed_signup-->

2
docs/topics/project-management.md
View File

@ -17,7 +17,7 @@ We have a quarterly maintenance cycle where new members may join the maintenance
#### Current team #### Current team
The [maintenance team for Q1 2015](https://github.com/tomchristie/django-rest-framework/issues/2190): The [maintenance team for Q4 2015](https://github.com/tomchristie/django-rest-framework/issues/2190):
* [@tomchristie](https://github.com/tomchristie/) * [@tomchristie](https://github.com/tomchristie/)
* [@xordoquy](https://github.com/xordoquy/) (Release manager.) * [@xordoquy](https://github.com/xordoquy/) (Release manager.)

16
docs_theme/base.html
View File

@ -38,14 +38,11 @@
</script> </script>
<style> <style>
span.fusion-wrap a { #sidebarInclude img {
display: block; margin-bottom: 10px;
margin-top: 10px;
color: black;
} }
a.fusion-poweredby { #sidebarInclude a.promo {
display: block; color: black;
margin-top: 10px;
} }
@media (max-width: 767px) { @media (max-width: 767px) {
div.promo { div.promo {
@ -104,12 +101,10 @@
{% endfor %} {% endfor %}
{% endfor %} {% endfor %}
{% if current_page and current_page.is_homepage %}
<div class="promo"> <div class="promo">
<hr/> <hr/>
<script type="text/javascript" src="//cdn.fusionads.net/fusion.js?zoneid=1332&serve=C6SDP2Y&placement=djangorestframework" id="_fusionads_js"></script> <div id="sidebarInclude">
</div> </div>
{% endif %}
</ul> </ul>
</div> </div>
@ -146,6 +141,7 @@
<script src="{{ base_url }}/js/jquery-1.8.1-min.js"></script> <script src="{{ base_url }}/js/jquery-1.8.1-min.js"></script>
<script src="{{ base_url }}/js/prettify-1.0.js"></script> <script src="{{ base_url }}/js/prettify-1.0.js"></script>
<script src="{{ base_url }}/js/bootstrap-2.1.1-min.js"></script> <script src="{{ base_url }}/js/bootstrap-2.1.1-min.js"></script>
<script src="https://fund.django-rest-framework.org/sidebar_include.js"></script>
<script>var base_url = '{{ base_url }}';</script> <script>var base_url = '{{ base_url }}';</script>
<script src="{{ base_url }}/mkdocs/js/require.js"></script> <script src="{{ base_url }}/mkdocs/js/require.js"></script>
<script src="{{ base_url }}/js/theme.js"></script> <script src="{{ base_url }}/js/theme.js"></script>

2
mkdocs.yml
View File

@ -63,4 +63,6 @@ pages:
- '3.2 Announcement': 'topics/3.2-announcement.md' - '3.2 Announcement': 'topics/3.2-announcement.md'
- '3.3 Announcement': 'topics/3.3-announcement.md' - '3.3 Announcement': 'topics/3.3-announcement.md'
- 'Kickstarter Announcement': 'topics/kickstarter-announcement.md' - 'Kickstarter Announcement': 'topics/kickstarter-announcement.md'
- 'Mozilla Grant': 'topics/mozilla-grant.md'
- 'Funding': 'topics/funding.md'
- 'Release Notes': 'topics/release-notes.md' - 'Release Notes': 'topics/release-notes.md'