From Fedora Project Wiki
 
(23 intermediate revisions by 3 users not shown)
Line 1: Line 1:
= Frappe Framework =
== Summary ==
== Summary ==
A full-stack web framework based on Python and Javascript to help you build powerful business apps and nifty extensions.
A full-stack web framework based on Python and Javascript to help you build powerful business apps and nifty extensions.
Line 12: Line 13:
* Targeted release: [[Releases/23 | Fedora 23 ]]  
* Targeted release: [[Releases/23 | Fedora 23 ]]  
* Last updated: 06-04-2014
* Last updated: 06-04-2014
* Tracker bug: <will be assigned by the Wrangler>
* Tracker bug: [https://bugzilla.redhat.com/show_bug.cgi?id=1233101 #1233101]


== Detailed Description ==
== Detailed Description ==
 
* Frappe is a Python and JavaScript framework.
<!-- Expand on the summary, if appropriate. A couple sentences suffices to explain the goal, but the more details you can provide the better. -->
* Frappe is the Framework on top ERPNext it is builded.
* Frappe has libraries and API for everything from authentication to reports.
* Frappe is built with the philosophy make it a "battries included" framework


== Benefit to Fedora ==
== Benefit to Fedora ==
Bring to Fedora a Python Framework with active upstream community and a growing user community. Please note that Fedora will become the first Linux distribution to ship the Frappe Framework.


== Scope ==
 
* Proposal owners: Initial work has been done for ERPNext (an accounting system built on the top of Frappe) on F22 in [https://copr.fedoraproject.org/coprs/williamjmorenor/ERPNext/ a Copr repository]. Patches and quick fixes should be cleaned up or revisited.
<!-- What is the benefit to the platform?  If this is a major capability update, what has changed?  If this is a new functionality, what capabilities does it bring? Why will Fedora become a better distribution or project because of this proposal?-->


== Scope ==
{|
* Proposal owners:
! Package name
! Task
! Status
|-
|python-semantic-version
|Create
|{{result|pass|}} [https://bugzilla.redhat.com/1207280 1207280]
|-
|python-frappe
|Create
|{{result|pass|williamjmorenor}} [https://bugzilla.redhat.com/show_bug.cgi?id=1228942 1228942]
|-
|python-frappe-bench
|Create
|{{result|pass|williamjmorenor}} [https://bugzilla.redhat.com/show_bug.cgi?id=1228943 1228943]
|-
|python-chardet
|Update to 2.3.0
|{{result|inprogress|mayorga}} [https://bugzilla.redhat.com/show_bug.cgi?id=1150536 1150536]
|-
|pytz
|Update to 2015.4
|{{result|inprogress|mayorga}} [https://bugzilla.redhat.com/show_bug.cgi?id=1161236 1161236]
|-
|python-werkzeug
|Update to 0.10.4
|{{result|inprogress|mayorga}} [https://bugzilla.redhat.com/show_bug.cgi?id=1206178 1206178]
|-
|python-html2text
|Update to 2015.6.6
|{{result|pass|mayorga}} [https://bugzilla.redhat.com/show_bug.cgi?id=1229552 1229552]
|-
|nodejs-prismjs
|Create
|{{result|inprogress|mayorga}} [https://bugzilla.redhat.com/show_bug.cgi?id=1229552 1229552]
|-
|nodejs-flot
|Create
|{{result|pass|mayorga}} [https://bugzilla.redhat.com/show_bug.cgi?id=1229552 1229552]
|-
|python-js-beautify
|Create
|{{result|pass|mayorga}} [https://bugzilla.redhat.com/show_bug.cgi?id=1229552 1229552]
|}
<!-- What work do the feature owners have to accomplish to complete the feature in time for release?  Is it a large change affecting many parts of the distribution or is it a very isolated change? What are those changes?-->
<!-- What work do the feature owners have to accomplish to complete the feature in time for release?  Is it a large change affecting many parts of the distribution or is it a very isolated change? What are those changes?-->


* Other developers: N/A (not a System Wide Change) <!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
* Other developers: not a System Wide Change <!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
<!-- What work do other developers have to accomplish to complete the feature in time for release?  Is it a large change affecting many parts of the distribution or is it a very isolated change? What are those changes?-->
<!-- What work do other developers have to accomplish to complete the feature in time for release?  Is it a large change affecting many parts of the distribution or is it a very isolated change? What are those changes?-->


* Release engineering: N/A (not a System Wide Change) <!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
* Release engineering: not a System Wide Change  <!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
<!-- Does this feature require coordination with release engineering (e.g. changes to installer image generation or update package delivery)?  Is a mass rebuid required?  If a rel-eng ticket exists, add a link here.  
<!-- Does this feature require coordination with release engineering (e.g. changes to installer image generation or update package delivery)?  Is a mass rebuid required?  If a rel-eng ticket exists, add a link here.  
Please work with releng prior to feature submission, and ensure that someone is on board to do any process development work and testing; don't just assume that a bullet point in a change puts someone else on the hook  -->
Please work with releng prior to feature submission, and ensure that someone is on board to do any process development work and testing; don't just assume that a bullet point in a change puts someone else on the hook  -->


* Policies and guidelines: N/A (not a System Wide Change) <!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
* Policies and guidelines: not a System Wide Change <!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
<!-- Do the packaging guidelines or other documents need to be updated for this feature?  If so, does it need to happen before or after the implementation is done?  If a FPC ticket exists, add a link here. -->
<!-- Do the packaging guidelines or other documents need to be updated for this feature?  If so, does it need to happen before or after the implementation is done?  If a FPC ticket exists, add a link here. -->


* Trademark approval: N/A (not needed for this Change)
* Trademark approval: not needed for this Change
<!-- If your Change may require trademark approval (for example, if it is a new Spin), file a ticket ( https://fedorahosted.org/council/ ) requesting trademark approval from the Fedora Council. This approval will be done via the Council's consensus-based process. -->
<!-- If your Change may require trademark approval (for example, if it is a new Spin), file a ticket ( https://fedorahosted.org/council/ ) requesting trademark approval from the Fedora Council. This approval will be done via the Council's consensus-based process. -->


Line 45: Line 91:


<!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
<!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
N/A (not a System Wide Change)  
N/A (not a System Wide Change)


== How To Test ==
== How To Test ==
<!-- This does not need to be a full-fledged document. Describe the dimensions of tests that this change implementation is expected to pass when it is done. If it needs to be tested with different hardware or software configurations, indicate them.  The more specific you can be, the better the community testing can be.
In f23 and rawhide python-frappe is missing nodejs-prismjs you will need to install by hand with:
 
dnf install -y https://copr-be.cloud.fedoraproject.org/results/williamjmorenor/python-frappe-f22/fedora-22-x86_64/nodejs-flot-0.8.3-2.fc24/nodejs-flot-0.8.3-2.fc22.noarch.rpm
 
You can track the review request of the missing dependency in https://bugzilla.redhat.com/show_bug.cgi?id=1246720
 
'''Test 0 - Install the Frappe Framework and Import it in Python'''
 
Install the framework with
 
    dnf install python-frappe
 
Open a interactive sesion in Python2 and import frappe
 
    >>> import frappe
 
'''Test 1 - Create your first Frappe Based Website'''
 
1- Start the mariadb servide with
 
    su -c "systemctl start mariadb"
 
2- Set a mariadb root passworod
 
    su -c "/usr/bin/mysql_secure_installation"


Remember that you are writing this how to for interested testers to use to check out your change implementation - documenting what you do for testing is OK, but it's much better to document what *I* can do to test your change.
3- Add your user to the frappe group


A good "how to test" should answer these four questions:
    su -c "usermod -a -G frappe $USER"


0. What special hardware / data / etc. is needed (if any)?
4- Create your firts Frappe website
1. How do I prepare my system to test this change? What packages
need to be installed, config files edited, etc.?
2. What specific actions do I perform to check that the change is
working like it's supposed to?
3. What are the expected results of those actions?
-->


<!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
    bench new-site fedora-test
N/A (not a System Wide Change)


== User Experience ==
== User Experience ==
<!-- If this change proposal is noticeable by its target audience, how will their experiences change as a result?  Describe what they will see or notice. -->
<!-- If this change proposal is noticeable by its target audience, how will their experiences change as a result?  Describe what they will see or notice. -->
<!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
<!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
N/A (not a System Wide Change)  
N/A (not a System Wide Change)


== Dependencies ==
== Dependencies ==
<!-- What other packages (RPMs) depend on this package?  Are there changes outside the developers' control on which completion of this change depends?  In other words, completion of another change owned by someone else and might cause you to not be able to finish on time or that you would need to coordinate?  Other upstream projects like the kernel (if this is not a kernel change)? -->
N/A (not a System Wide Change)
 
<!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
N/A (not a System Wide Change)  


== Contingency Plan ==
== Contingency Plan ==
 
* Contingency mechanism: not a System Wide Change, is the Frappe Framework is not ready for user we will point to the f24 release, unstable packages can be found [https://copr.fedoraproject.org/coprs/williamjmorenor/ERPNext/ here]
<!-- If you cannot complete your feature by the final development freeze, what is the backup plan?  This might be as simple as "Revert the shipped configuration".  Or it might not (e.g. rebuilding a number of dependent packages).  If you feature is not completed in time we want to assure others that other parts of Fedora will not be in jeopardy. -->
* Contingency mechanism: (What to do?  Who will do it?) N/A (not a System Wide Change)  <!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
<!-- When is the last time the contingency mechanism can be put in place?  This will typically be the beta freeze. -->
<!-- When is the last time the contingency mechanism can be put in place?  This will typically be the beta freeze. -->
* Contingency deadline: N/A (not a System Wide Change) <!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
* Contingency deadline: not a System Wide Change  <!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
<!-- Does finishing this feature block the release, or can we ship with the feature in incomplete state? -->
<!-- Does finishing this feature block the release, or can we ship with the feature in incomplete state? -->
* Blocks release? N/A (not a System Wide Change), Yes/No <!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
* Blocks release? not a System Wide Change, No <!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
* Blocks product? product <!-- Applicable for Changes that blocks specific product release/Fedora.next -->
* Blocks product? not a System Wide Change, No <!-- Applicable for Changes that blocks specific product release/Fedora.next -->


== Documentation ==
== Documentation ==
Line 99: Line 157:
-->
-->


[[Category:ChangePageIncomplete]]
[[Category:ChangeAcceptedF23]]
<!-- When your change proposal page is completed and ready for review and announcement -->
<!-- When your change proposal page is completed and ready for review and announcement -->
<!-- remove Category:ChangePageIncomplete and change it to Category:ChangeReadyForWrangler -->
<!-- remove Category:ChangePageIncomplete and change it to Category:ChangeReadyForWrangler -->

Latest revision as of 23:11, 7 August 2015

Frappe Framework

Summary

A full-stack web framework based on Python and Javascript to help you build powerful business apps and nifty extensions.

Owner

Current status

Detailed Description

  • Frappe is a Python and JavaScript framework.
  • Frappe is the Framework on top ERPNext it is builded.
  • Frappe has libraries and API for everything from authentication to reports.
  • Frappe is built with the philosophy make it a "battries included" framework

Benefit to Fedora

Bring to Fedora a Python Framework with active upstream community and a growing user community. Please note that Fedora will become the first Linux distribution to ship the Frappe Framework.

Scope

  • Proposal owners: Initial work has been done for ERPNext (an accounting system built on the top of Frappe) on F22 in a Copr repository. Patches and quick fixes should be cleaned up or revisited.
Package name Task Status
python-semantic-version Create
Pass pass
1207280
python-frappe Create 1228942
python-frappe-bench Create 1228943
python-chardet Update to 2.3.0
Inprogress inprogress mayorga
1150536
pytz Update to 2015.4
Inprogress inprogress mayorga
1161236
python-werkzeug Update to 0.10.4
Inprogress inprogress mayorga
1206178
python-html2text Update to 2015.6.6
Pass pass mayorga
1229552
nodejs-prismjs Create
Inprogress inprogress mayorga
1229552
nodejs-flot Create
Pass pass mayorga
1229552
python-js-beautify Create
Pass pass mayorga
1229552
  • Other developers: not a System Wide Change
  • Release engineering: not a System Wide Change
  • Policies and guidelines: not a System Wide Change
  • Trademark approval: not needed for this Change

Upgrade/compatibility impact

N/A (not a System Wide Change)

How To Test

In f23 and rawhide python-frappe is missing nodejs-prismjs you will need to install by hand with:

dnf install -y https://copr-be.cloud.fedoraproject.org/results/williamjmorenor/python-frappe-f22/fedora-22-x86_64/nodejs-flot-0.8.3-2.fc24/nodejs-flot-0.8.3-2.fc22.noarch.rpm

You can track the review request of the missing dependency in https://bugzilla.redhat.com/show_bug.cgi?id=1246720

Test 0 - Install the Frappe Framework and Import it in Python

Install the framework with 

   dnf install python-frappe

Open a interactive sesion in Python2 and import frappe 

   >>> import frappe

Test 1 - Create your first Frappe Based Website

1- Start the mariadb servide with 

   su -c "systemctl start mariadb"

2- Set a mariadb root passworod 

   su -c "/usr/bin/mysql_secure_installation"

3- Add your user to the frappe group 

   su -c "usermod -a -G frappe $USER"

4- Create your firts Frappe website 

   bench new-site fedora-test

User Experience

N/A (not a System Wide Change)

Dependencies

N/A (not a System Wide Change)

Contingency Plan

  • Contingency mechanism: not a System Wide Change, is the Frappe Framework is not ready for user we will point to the f24 release, unstable packages can be found here
  • Contingency deadline: not a System Wide Change
  • Blocks release? not a System Wide Change, No
  • Blocks product? not a System Wide Change, No

Documentation

N/A (not a System Wide Change)

Release Notes

Retrieved from "https://fedoraproject.org/w/index.php?title=Changes/frappe-framework&oldid=419629"