Application Submission

From DevWiki

Jump to: navigation, search

Back to Home

Contents


Overview

Submitting applications to Boxee is done via Boxee issue tracking system at jira.boxee.tv.
Boxee has the right to refuse submissions to the Boxee Applications Directory if they do not meet the Terms of Use.
Boxee will review the submitted applications and once approved, it will be added to the Boxee Applications Directory and an email response will be sent to the application developer.

At this time, the Boxee API is open to the general public. However, in the future a developer key may be required to access certain portions of the code.

Prepare your Application

please perform the following checklist before emailing your application to Boxee
Application Name
When naming a Boxee application it's important to be specific - create a name that quickly distinguishes your application from others available on Boxee - this means your collection of great comedy movie scenes from the 90s probably shouldn't just be called "Funny Scenes" :)

Additionally your application name should not be anything that's copyrighted or trademarked. The easiest way to avoid this issue is to do a quick web search for the name of your application. If there's a company, product, or existing show with that name in the first 2-3 pages of results we suggest you change it or reach out to the company to gain permission. If you do obtain permission to use the name please let us know when submitting your application.

Remove unused files and folders
Clear any files/temp files which are not required for you application to run.

  • remove thumbs.db, hidden files and directories such as .svn
  • remove backup files, or files that ends with ~.

Application Descriptor
Tripple check your descriptor.xml

  • email: Make sure your email or support email is included in the descriptor. The default Boxee support email should not be used if it wasn't developed by Boxee.
  • thumbnail: Your thumbnail MUST be a 200x200 png.
  • adult content: if your app contains adult content, the rating tag <rating>adult</rating> must be present.
  • remove the test-app tag.
  • For more descriptor "musts", read Anatomy of a Boxee App under descriptor section.

Source code
We ask that if your application contains python scripts to please include the py file and not just the compile pyo files. Although the app will still function its best to keep the code as open as possible. However if you are working with a company that requires this you can zip only the pyo but you must include the uncompiled python code in another zip file and send it with submission as all files must be scanned by our QA team for possible malicious code.

Package

  • Make sure to increment the version number every time you send Boxee new a version of your application.
  • Compress zip you application folder up in normal zip compression. The zip name is very important. appid-version.zip (example: appid-1.56.zip)
  • compress the directory using the console zip utility. This will create an archive without including mac hidden folders/files such as __MACOSX ._.DS_Store .DS_Store

zip -r appid-version.zip *

Submission

Register to Boxee issue tracking system at jira.boxee.tv.
We will open an application component in jira for you to track down issues found, if any, with your application.

Once you are registered to jira and have your application zipped up and ready for submission:
open an "Project:Application Support > Issue Type: Application Submission" jira issue.

add the following details into the issue fields:
Summery: Application submission of Application Name
Description:

  • Full Name:
  • Email Address:
  • Jira Username:
  • Personal/Company Website:

Include the following details as they appear in your descriptor.xml

  • Application ID:
  • Application Name:
  • Application Description:
  • Additional Information: Anything you'd like to add.


Attachment: Attach your zipped application to the jira issue.

Remarks:

  • By utilize the Boxee API and submitting your application to Boxee repository you you are agreeing to and accepting the terms and conditions set forth in the API Terms of Service http://developer.boxee.tv/API_Terms_of_Service
  • If your zip is larger than 2.5 MB, you can email it to app-submit AT boxee d0t tv
  • Applications are added to the repository few times a week.
  • You will receive an email once your application has been approved by our QA and submitted to Boxee applications repository.
Retrieved from "http://developer.boxee.tv/Application_Submission"
Personal tools