GNU MediaGoblin Wiki - User contributions [en]

CommunityGovernance

2016-01-04T13:09:25Z

ShawnRisk:

MediaGoblin is a community project and we everybody try to help each other. Chris Webber is our lead developer, but the project should be able to self govern so he can take a break if he needs it or when he or other contributors take deserved holidays :)

In general, you can ask anything in the mailing list or the IRC channel and hopefully somebody will answer soon. Topics are discussed in the mailing list, IRC channel or monthly meetings (in the IRC channel).

In this page we list several tasks or areas along with the names or nicks of MediaGoblin community members that may help on them (for example, because they have permissions to perform certain operations). Please be kind when asking for help, most of us are volunteering for MediaGoblin in our free time, so answers or problems resolution can take a while.

Feel free to edit this page to list more tasks or sign the ones you self-assign.

More information about this in this mailing list thread: http://lists.mediagoblin.org/pipermail/devel/XXXXX

== MediaGoblin codebase ==

* People with permissions to commit/merge and handle the main codebase

* Current committers: https://savannah.gnu.org/project/memberlist.php?group=mediagoblin
* General stuff: breton, Elrond (via PM on IRC)
* Python 3 support: berkerpeksag (berker on IRC), breton
* Audio/Video: breton
* Documentation: jcampbell / j1mc

== MediaGoblin website ==

* People with permissions to handle website outages
** breton
** simonft
** Chris Webber (paroneayea on freenode)

* Publish pages (for example new releases)

== MediaGoblin wiki ==

* Some Wiki administration: Elrond (via PM on IRC)

== MediaGoblin issue tracker ==

* Issue tracker server administration: simonft, paroneayea
* Help triaging bugs: R13ose
* People with permissions to create accounts in trac: Elrond
* People with permissions to delete users/issues/comments in trac: Elrond
* Volunteers for spam cleaning: LArjona, ayleph
* Talk to trac people about features and spam: R13ose
* Would like more access to be able to help/fix things:

== MediaGoblin translation platform ==

* If there is need of manual import/export files between Pootle and the MediaGoblin codebase, who can help on that
* LArjona (Spanish translator) can guide new translators, reproduce problems in the translation platform, test changes, and help with Pootle quality checks. Available in the mailing list and IRC channel.
* breton knows how and why translations are downloaded/compiled

== MediaGoblin IRC channel and mailing list ==

* Change IRC topic, channel operators
* Running the monthly meetings: breton
* Administrate the mailing list: larjona

CommunityGovernance

2015-07-02T13:25:13Z

ShawnRisk:

MediaGoblin is a community project and we everybody try to help each other. Chris Webber is our lead developer, but the project should be able to self govern so he can take a break if he needs it or when he or other contributors take deserved holidays :)

In general, you can ask anything in the mailing list or the IRC channel and hopefully somebody will answer soon. Topics are discussed in the mailing list, IRC channel or monthly meetings (in the IRC channel).

In this page we list several tasks or areas along with the names or nicks of MediaGoblin community members that may help on them (for example, because they have permissions to perform certain operations). Please be kind when asking for help, most of us are volunteering for MediaGoblin in our free time, so answers or problems resolution can take a while.

Feel free to edit this page to list more tasks or sign the ones you self-assign.

More information about this in this mailing list thread: http://lists.mediagoblin.org/pipermail/devel/XXXXX

== MediaGoblin codebase ==

* People with permissions to commit/merge and handle the main codebase

* General stuff: breton, Elrond (via PM on IRC)
* Python 3 support: berkerpeksag (berker on IRC), breton
* Audio/Video: breton
* Documentation: jcampbell / j1mc

== MediaGoblin website ==

* People with permissions to handle website outages

* Publish pages (for example new releases)

== MediaGoblin wiki ==

* Some Wiki administration: Elrond (via PM on IRC)

== MediaGoblin issue tracker ==

* Help triaging bugs: R13ose
* People with permissions to create accounts in trac: Elrond
* People with permissions to delete users/issues/comments in trac: Elrond
* Volunteers for spam cleaning: LArjona, ayleph
* Talk to trac people about spam: R13ose
* Would like more access to be able to help/fix things:

== MediaGoblin translation platform ==

* If there is need of manual import/export files between Pootle and the MediaGoblin codebase, who can help on that
* LArjona (Spanish translator) can guide new translators, reproduce problems in the translation platform, test changes, and help with Pootle quality checks. Available in the mailing list and IRC channel.
* breton knows how and why translations are downloaded/compiled

== MediaGoblin IRC channel and mailing list ==

* Change IRC topic, channel operators
* Running the monthly meetings: breton
* Administrate the mailing list: larjona

CommunityGovernance

2015-06-08T12:42:22Z

ShawnRisk: /* MediaGoblin issue tracker */

MediaGoblin is a community project and we everybody try to help each other. Chris Webber is our lead developer, but the project should be able to self govern so he can take a break if he needs it or when he or other contributors take deserved holidays :)

In general, you can ask anything in the mailing list or the IRC channel and hopefully somebody will answer soon. Topics are discussed in the mailing list, IRC channel or monthly meetings (in the IRC channel).

In this page we list several tasks or areas along with the names or nicks of MediaGoblin community members that may help on them (for example, because they have permissions to perform certain operations). Please be kind when asking for help, most of us are volunteering for MediaGoblin in our free time, so answers or problems resolution can take a while.

Feel free to edit this page to list more tasks or sign the ones you self-assign.

More information about this in this mailing list thread: http://lists.mediagoblin.org/pipermail/devel/XXXXX

== MediaGoblin codebase ==

* People with permissions to commit/merge and handle the main codebase

* General stuff: breton, Elrond (via PM on IRC)
* Python 3 support: berkerpeksag (berker on IRC), breton
* Audio/Video: breton
* Documentation: jcampbell / j1mc

== MediaGoblin website ==

* People with permissions to handle website outages

* Publish pages (for example new releases)

== MediaGoblin wiki ==

* Wiki administration

== MediaGoblin issue tracker ==

* Help triaging bugs: R13ose

* People with permissions to create accounts in trac

* People with permissions to delete users/issues/comments in trac

* Volunteers for spam cleaning: LArjona

* Talk to trac people about spam: R13ose

== MediaGoblin translation platform ==

* If there is need of manual import/export files between Pootle and the MediaGoblin codebase, who can help on that
* LArjona (Spanish translator) can guide new translators, reproduce problems in the translation platform, test changes, and help with Pootle quality checks. Available in the mailing list and IRC channel.
* breton knows how and why translations are downloaded/compiled

== MediaGoblin IRC channel and mailing list ==

* Change IRC topic, channel operators

Meeting

2013-03-02T14:50:10Z

ShawnRisk: /* Next Meeting */

== MediaGoblin Monthly Meeting ==

'''When:''' 9:00 am Pacific Time first Saturday of the month. [http://www.timeanddate.com/worldclock/converter.html Convert time to your timezone]. Print current UTC time: <code>date -u +"It's %F %T UTC"</code>

'''Where:''' IRC #mediagoblin on irc.freenode.net

Always announced several days in advance on the [http://lists.mediagoblin.org/pipermail/devel/ mailing list] as is date adjustments, agenda discussion and other meeting preparation.

'''Purpose:''' The idea is to discuss the past month, what happened, what was good, what should be done better. And to create roadmap for the upcoming month and assign tasks to people willing to handle them.

Typical Agenda topics:

* What happened in the last month, what was good, what could be better next time?
* What should be done next month?

Meetings are logged. [http://mediagoblin.org/irclogs/ Logs for past meetings.]

== Next Meeting ==

* Bug triage day discussion
* Upgrading Trac to 1.0
* Consider have release dates?
* Consider moving to GStreamer 1.0
** Debian - 1.0 in sid
** Ubuntu - 1.0 in 12.10
*** Possibly backports for 12.04
** Fedora - 1.0 in 18

== Past Meetings ==

=== February 9th, 2013, 9:00 am Pacific Time (2013-02-09 16:00 UTC) ===

* 0.3.3 milestone! What about our next release? :)
* Where to put Developer docs?
*: Our Documentation for developers is currently a bit split. Some are on the wiki, some in the main docs. There are pros and cons for both. We should consider where to put things. One place? Which? Or decide on an individual basis?
*: Good about main docs: Easy to integrate source code doc strings. That way internal api docs can be kept mostly up to date.
*: Good about wiki: Doesn't feel so "set in stone".
* wiki spam: Do we want to change something?
* [http://lists.mediagoblin.org/pipermail/devel/2012-November/000307.html Designing features!]
* Plugins, and architecting for plugins
* Chris Webber gives updates on how he's settling into his role ;)

=== October 13th, 2012, 9:00 am Pacific Time (2012-10-13 16:00 UTC) ===

* 0.3.2 release
** What existing features need to be wrapped up?
*** Werkzeug switch
** What time might we do the release?
* Fundraising campaign
** Keeping things going mid-campaign
** You have questions? I have answers, kinda :)
* Getting new contributors involved
* Plugins? New features?

==== Etherpad ====
<pre>
AGENDA

0.3.2 release

What existing features need to be wrapped up?

Werkzeug switch

What time might we do the release?

Congrats to Deb from the mediagoblin team! Congrats de Deb!

Fundraising campaign

Keeping things going mid-campaign

You have questions? I have answers, kinda :)

Getting new contributors involved

Plugins? New features?

-- http://wiki.mediagoblin.org/Meeting#Next_Meeting
Fundraising stuff
Things are going great mostly when people check it out!
But how to spread the word?

should contact more podcasts, etc

currently working with FSF on this

need community to spread the word!

List of places already spreaded list and contacted

VideoThumbnailerMarkII
New video thumbnailer, rewritten to try to eliminate a bug in the old one where processing would stall.
New bugs introduce (of course ;)
Collections
Merged - Thanks aaronw!
WebOb => Werkzeug switch
Made some things break. Need help with testing + bugfixes
borked stuffs:

Accessing paths without trailing slashes, e.g. /submit (instead of /submit/)

Still a lot of legacy WebOb responses (such as webob.exc.HTTPFound() HTTPForbidden() left)

API
Delivered to mrn.is, tryggvib will test it and get back with feedback.
Working, still a lot of room for improvements.
Mostly done, usable, still room for improvements. Example applications:

https://github.com/jwandborg/automgtic

https://github.com/jwandborg/omgmg
</pre>

=== September 1st, 2012, 9:00 am Pacific Time (2012-09-01 16:00 UTC) ===

[http://mediagoblin.org/irclogs/irc_meeting_2012-09-01.txt IRC log]

* FIXME - can someone type in summary here?

=== August 4th, 2012, 9:00 am Pacific Time (2012-08-04 16:00 UTC) ===

[http://mediagoblin.org/irclogs/irc_meeting_2012-08-04.txt IRC log]

* Release schedule
* Plugins and themes! Who's working on one? What problems are you having? -- Please write up issues for problems so they can get fixed!
* Should we namespace plugins? If so, how should we namespace plugins?
** Python 3.3 will have support for namespace plugins. [http://www.python.org/dev/peps/pep-0420/#namespace-packages-today]
** In Python >=2.3, <3.3 it's a hack [http://www.python.org/dev/peps/pep-0402/#the-problem][http://www.python.org/dev/peps/pep-0420/#namespace-packages-today]
** Flask has a workaround[https://github.com/mitsuhiko/flask/blob/master/flask/ext/__init__.py]

=== July 7th, 2012, 9:00 am Pacific Time (2012-07-07 16:00 UTC) ===

[http://mediagoblin.org/irclogs/irc_meeting_2012-07-07.txt IRC log]

Announcements:

* Anyone who wants to edit the wiki needs to be in the goblin army group. Ask Will or Chris to get added.
* Plugin infrastructure landed. If you're interested in writing plugins, talk to Will. Some documentation at http://docs.mediagoblin.org/#part-2-plugin-writer-s-guide

Agenda:

* Keyboard shortcuts ([http://issues.mediagoblin.org/ticket/346 #346])
* Ticket triaging?
* Base plugin stuff!
* Theming
* Conference: OSCON
* Chris Webber's new "office hours"

=== June 2nd, 2012, 9:00 am Pacific Time ===

[http://mediagoblin.org/irclogs/irc_meeting_2012-06-02.txt IRC log]

* docs changes
** Will split the docs/ guide into a Site Administrator's Guide and a Plugin Writer's Guide
** Has anyone looked at the Plugin Writer's Guide, yet?
** Will wants to add a "Contributor's Guide" to docs/ which he'd update from the wiki before every release
* Is there a way to improve our unit tests and motivation to write them?
** Simulating a browser by the way of [http://phantomjs.org/ PhantomJS], [http://seleniumhq.org/ Selenium] instead of having code simulating other code against itself might be more natural to write and even more testing the actual application. I have a good feeling about this, please prove me wrong if I'd be. --[[User:Joar|Joar]] 08:53, 28 May 2012 (EDT)
* Administrative panel/tools and user uploads panel
* Git and tickets
* Plugins
** What's the state of things?
** Documentation
** What plugins might we want to build for this upcoming release?
** What things do we currently have that we might want to pluginify?
* State of kuneco/federation mini-update (Chris)

=== May 5th, 2012, 9:00 am Pacific Time ===

[http://mediagoblin.org/irclogs/irc_meeting_2012-05-05.txt IRC log]

* Post-release reflections
** Woohoo, release!
** How did this release process go?
*** We should talk about that conference.
** What's left to clean up?
*** Mongokit->SQL "style" query conversion?
*** Other cruft code?
* What are our next goals?
** Plugins
** Federation
** Favoriting
*** Take that, Pinterest! ;)
** Galleries
** Theming
*** Using sass would be neat
** Access restrictions
*** User management, or having a "secret url" that is not in the photo index that you can share with friends and generate as needed for any media type
** What about traffic? Some of us will host GMG on limited plans.
** Some kind of coding guidelines? Do we have a philosophy like "Keep it Simple, Stupid"
*** This concerns things like: Should plugins land in core eventually, do we want to support ALL THE MEDIA TYPES, ...
** Podcasting support?
** Things that have been hanging???
** Bugtrackers and milestone?
** More??? We should organize things!
* jancborchardt and his team of UX wizard-students
* Website redesign
* OpenShift?

=== April 7th, 2012, 4:00 pm UTC ===

[http://mediagoblin.org/irclogs/irc_meeting_2012-04-07.txt IRC log]

* Post-SQL stuff
* Pending 0.0.3 release!
* Are there stray patches/branches to be merged?
* Our glorious upcoming plugin future! (Update from Will)

=== March 3rd, 2012, 9:00 am Pacific Time ===

[http://mediagoblin.org/irclogs/irc_meeting_2012-03-03.txt IRC log]

* [[GSOC 2012]]
* State of the SQL transition (preview: it's super close, but we need help!)
* Plugin discussion (Will can't make this, but we should talk about use cases)
* MediaGoblin at upcoming conferences
* PageKite accounts

=== 2012-02 (held on 2012-02-04) ===

[http://mediagoblin.org/irclogs/irc_meeting_2012-02-04.txt IRC log]

* Code style guide? See also: http://issues.mediagoblin.org/ticket/197
* Kuneco/federation
* API
* More testing discussion?
* Theming?
* Preliminary plugin discussion
* Status update from the "SQL Team".

Some of the decisions:

* file an issue about proper <audio> support.
* some TODOs recorded

=== 2011-12 (held on 2011-12-03) ===

[http://mediagoblin.org/irclogs/irc_meeting_2011-12-03.txt IRC log]

* We plan to create a plugin system. Do we want to create that soon or push it off until things settle a bit more? ([[User:Willkg|Willkg]] 08:54, 10 November 2011 (EST))
* [[Feature Ideas]]: What should we do about the wiki page? Keep it and have it as a monthly topic for "what next"? Convert everything to long waiting bugs?
* Possibility of an [[SQL Database Backend]]?
*: 'executive summary' (well, you should read the long docs): "We could move to sql. It's probably replacing one type of pain by another type of pain, but those are somewhat comparable. Leaving the main question: Do we want to occupy our main devs for some long time with this task and loose momentum?"
* Schendje's [http://wiki.mediagoblin.org/Feature_Ideas/Activities activities proposal]
* "Coming up next" blogpost draft by Deb Nicholson
* Jef's requests:
** Ticket #466 "Use of "Submit" in site copy is sterile and not as friendly and welcoming as it could be". I'd really like to change this soon to something more suitable. How can we improve the wording here? Some alternatives have been mentioned in the bug report, but which one should we pick? Link: http://bugs.foocorp.net/issues/466
** The concept and naming of "favourites". We'll (hopefully) be able to "favourite" media soon, which I *think* means that 1) it'll work like a "I like this" comment, a quick token of appreciation, 2) it'll be added to your list of favourites so you can save and promote it, and 3) we could maybe use the number of favourites as a ranking. What I'd like to know is: is that the intended purpose? If so, should we name them favo(u)rites or something else? "Like", "love", "save", "appreciate", "heart", "high five" and many more could all be contenders. And the name should be consistent with the action and purpose, of course. So I'd like to clear up how and why we will use favourites and what we should call them.

=== 2011-11 (held on 2011-11-05) ===

[http://mediagoblin.org/irclogs/irc_meeting_2011-11-05.txt IRC log]

* What happened in the last month, what was good, what could be better next time?
** Release:
*** Good: 0.1.0 released!
*** Bad: postponing vs not postponing
** Sites and deployment documentation:
*** Good: new mediagoblin.org
*** Good: deployment documentation
*** Bad: py-bcrypt’s site was down just after the release, so the virtualenv deployment didn’t work, and it wasn’t clear how to fix it.
** Live instances:
*** Joar has a live instance!
*** But what does it mean? Should ordinary users start using it?
**** Details at [[User:Joar/mg.wandborg.se]] -- [[User:Joar|Joar]] 17:01, 6 November 2011 (EST)
*** nyergler added a note about "heartbeat"/status to API notes
* What should be done next month?
* Starting real work on federation (via OStatus)... and do we split any of this work out into its own library?
* An API
* Creative Commons licensing tools
* Merging in the multimedia/video branch
*: (this is *very close* already actually thanks to the hard work of Joar Wandborg! But we need some help on the gstreamer front to fix a few issues... if you or someone you know is an expert in this area we could really use their help to make the videos that come out smoother!)
* Rollover items from 0.1.0
* Multiple file upload interface
* Drag and drop uploads interface (probably related!)

=== 2011-10 (held on 2011-10-01) ===

[http://mediagoblin.org/irclogs/irc_meeting_2011-10-01.txt IRC log]

This month's meeting was a quickly announced short meeting. The project is getting back on track and next month's meeting will be scheduled more properly. A bunch of people were around.

The most important decisions:
* The project will keep monthly releases. They're the heartbeat of the project.
* Release 0.1.0 this sunday/monday.
* New website will hopefully be deployed in the next few days.
* And the following things are planned to happen during this month: Most importantly federation. The developers have decided to make up their minds on what federation aactually should mean for MediaGoblin. Concerning code, probably "activity streams" are the first goal. If there is no (good) python library for this, a new stand alone library may be created. If so, a name for it has to be found. It should have something about communication in it. And the other thing to happen during this month is an ongoing discussion about "bus factor".

=== 2011-09 (held on 2011-09-03) ===

[http://mediagoblin.org/irclogs/irc_meeting_2011-09-03.txt IRC log]

=== 2011-08 (held on 2011-08-06) ===

[http://mediagoblin.org/irclogs/irc_meeting_2011-08-06.txt IRC log]

Meeting

2013-02-23T21:02:42Z

ShawnRisk:

== MediaGoblin Monthly Meeting ==

'''When:''' 9:00 am Pacific Time first Saturday of the month. [http://www.timeanddate.com/worldclock/converter.html Convert time to your timezone]. Print current UTC time: <code>date -u +"It's %F %T UTC"</code>

'''Where:''' IRC #mediagoblin on irc.freenode.net

Always announced several days in advance on the [http://lists.mediagoblin.org/pipermail/devel/ mailing list] as is date adjustments, agenda discussion and other meeting preparation.

'''Purpose:''' The idea is to discuss the past month, what happened, what was good, what should be done better. And to create roadmap for the upcoming month and assign tasks to people willing to handle them.

Typical Agenda topics:

* What happened in the last month, what was good, what could be better next time?
* What should be done next month?

Meetings are logged. [http://mediagoblin.org/irclogs/ Logs for past meetings.]

== Next Meeting ==

* Bug triage day discussion
* Upgrading Trac to 1.0
* Consider moving to GStreamer 1.0
** Debian - 1.0 in sid
** Ubuntu - 1.0 in 12.10
*** Possibly backports for 12.04
** Fedora - 1.0 in 18

== Past Meetings ==

=== February 9th, 2013, 9:00 am Pacific Time (2013-02-09 16:00 UTC) ===

* 0.3.3 milestone! What about our next release? :)
* Where to put Developer docs?
*: Our Documentation for developers is currently a bit split. Some are on the wiki, some in the main docs. There are pros and cons for both. We should consider where to put things. One place? Which? Or decide on an individual basis?
*: Good about main docs: Easy to integrate source code doc strings. That way internal api docs can be kept mostly up to date.
*: Good about wiki: Doesn't feel so "set in stone".
* wiki spam: Do we want to change something?
* [http://lists.mediagoblin.org/pipermail/devel/2012-November/000307.html Designing features!]
* Plugins, and architecting for plugins
* Chris Webber gives updates on how he's settling into his role ;)

=== October 13th, 2012, 9:00 am Pacific Time (2012-10-13 16:00 UTC) ===

* 0.3.2 release
** What existing features need to be wrapped up?
*** Werkzeug switch
** What time might we do the release?
* Fundraising campaign
** Keeping things going mid-campaign
** You have questions? I have answers, kinda :)
* Getting new contributors involved
* Plugins? New features?

==== Etherpad ====
<pre>
AGENDA

0.3.2 release

What existing features need to be wrapped up?

Werkzeug switch

What time might we do the release?

Congrats to Deb from the mediagoblin team! Congrats de Deb!

Fundraising campaign

Keeping things going mid-campaign

You have questions? I have answers, kinda :)

Getting new contributors involved

Plugins? New features?

-- http://wiki.mediagoblin.org/Meeting#Next_Meeting
Fundraising stuff
Things are going great mostly when people check it out!
But how to spread the word?

should contact more podcasts, etc

currently working with FSF on this

need community to spread the word!

List of places already spreaded list and contacted

VideoThumbnailerMarkII
New video thumbnailer, rewritten to try to eliminate a bug in the old one where processing would stall.
New bugs introduce (of course ;)
Collections
Merged - Thanks aaronw!
WebOb => Werkzeug switch
Made some things break. Need help with testing + bugfixes
borked stuffs:

Accessing paths without trailing slashes, e.g. /submit (instead of /submit/)

Still a lot of legacy WebOb responses (such as webob.exc.HTTPFound() HTTPForbidden() left)

API
Delivered to mrn.is, tryggvib will test it and get back with feedback.
Working, still a lot of room for improvements.
Mostly done, usable, still room for improvements. Example applications:

https://github.com/jwandborg/automgtic

https://github.com/jwandborg/omgmg
</pre>

=== September 1st, 2012, 9:00 am Pacific Time (2012-09-01 16:00 UTC) ===

[http://mediagoblin.org/irclogs/irc_meeting_2012-09-01.txt IRC log]

* FIXME - can someone type in summary here?

=== August 4th, 2012, 9:00 am Pacific Time (2012-08-04 16:00 UTC) ===

[http://mediagoblin.org/irclogs/irc_meeting_2012-08-04.txt IRC log]

* Release schedule
* Plugins and themes! Who's working on one? What problems are you having? -- Please write up issues for problems so they can get fixed!
* Should we namespace plugins? If so, how should we namespace plugins?
** Python 3.3 will have support for namespace plugins. [http://www.python.org/dev/peps/pep-0420/#namespace-packages-today]
** In Python >=2.3, <3.3 it's a hack [http://www.python.org/dev/peps/pep-0402/#the-problem][http://www.python.org/dev/peps/pep-0420/#namespace-packages-today]
** Flask has a workaround[https://github.com/mitsuhiko/flask/blob/master/flask/ext/__init__.py]

=== July 7th, 2012, 9:00 am Pacific Time (2012-07-07 16:00 UTC) ===

[http://mediagoblin.org/irclogs/irc_meeting_2012-07-07.txt IRC log]

Announcements:

* Anyone who wants to edit the wiki needs to be in the goblin army group. Ask Will or Chris to get added.
* Plugin infrastructure landed. If you're interested in writing plugins, talk to Will. Some documentation at http://docs.mediagoblin.org/#part-2-plugin-writer-s-guide

Agenda:

* Keyboard shortcuts ([http://issues.mediagoblin.org/ticket/346 #346])
* Ticket triaging?
* Base plugin stuff!
* Theming
* Conference: OSCON
* Chris Webber's new "office hours"

=== June 2nd, 2012, 9:00 am Pacific Time ===

[http://mediagoblin.org/irclogs/irc_meeting_2012-06-02.txt IRC log]

* docs changes
** Will split the docs/ guide into a Site Administrator's Guide and a Plugin Writer's Guide
** Has anyone looked at the Plugin Writer's Guide, yet?
** Will wants to add a "Contributor's Guide" to docs/ which he'd update from the wiki before every release
* Is there a way to improve our unit tests and motivation to write them?
** Simulating a browser by the way of [http://phantomjs.org/ PhantomJS], [http://seleniumhq.org/ Selenium] instead of having code simulating other code against itself might be more natural to write and even more testing the actual application. I have a good feeling about this, please prove me wrong if I'd be. --[[User:Joar|Joar]] 08:53, 28 May 2012 (EDT)
* Administrative panel/tools and user uploads panel
* Git and tickets
* Plugins
** What's the state of things?
** Documentation
** What plugins might we want to build for this upcoming release?
** What things do we currently have that we might want to pluginify?
* State of kuneco/federation mini-update (Chris)

=== May 5th, 2012, 9:00 am Pacific Time ===

[http://mediagoblin.org/irclogs/irc_meeting_2012-05-05.txt IRC log]

* Post-release reflections
** Woohoo, release!
** How did this release process go?
*** We should talk about that conference.
** What's left to clean up?
*** Mongokit->SQL "style" query conversion?
*** Other cruft code?
* What are our next goals?
** Plugins
** Federation
** Favoriting
*** Take that, Pinterest! ;)
** Galleries
** Theming
*** Using sass would be neat
** Access restrictions
*** User management, or having a "secret url" that is not in the photo index that you can share with friends and generate as needed for any media type
** What about traffic? Some of us will host GMG on limited plans.
** Some kind of coding guidelines? Do we have a philosophy like "Keep it Simple, Stupid"
*** This concerns things like: Should plugins land in core eventually, do we want to support ALL THE MEDIA TYPES, ...
** Podcasting support?
** Things that have been hanging???
** Bugtrackers and milestone?
** More??? We should organize things!
* jancborchardt and his team of UX wizard-students
* Website redesign
* OpenShift?

=== April 7th, 2012, 4:00 pm UTC ===

[http://mediagoblin.org/irclogs/irc_meeting_2012-04-07.txt IRC log]

* Post-SQL stuff
* Pending 0.0.3 release!
* Are there stray patches/branches to be merged?
* Our glorious upcoming plugin future! (Update from Will)

=== March 3rd, 2012, 9:00 am Pacific Time ===

[http://mediagoblin.org/irclogs/irc_meeting_2012-03-03.txt IRC log]

* [[GSOC 2012]]
* State of the SQL transition (preview: it's super close, but we need help!)
* Plugin discussion (Will can't make this, but we should talk about use cases)
* MediaGoblin at upcoming conferences
* PageKite accounts

=== 2012-02 (held on 2012-02-04) ===

[http://mediagoblin.org/irclogs/irc_meeting_2012-02-04.txt IRC log]

* Code style guide? See also: http://issues.mediagoblin.org/ticket/197
* Kuneco/federation
* API
* More testing discussion?
* Theming?
* Preliminary plugin discussion
* Status update from the "SQL Team".

Some of the decisions:

* file an issue about proper <audio> support.
* some TODOs recorded

=== 2011-12 (held on 2011-12-03) ===

[http://mediagoblin.org/irclogs/irc_meeting_2011-12-03.txt IRC log]

* We plan to create a plugin system. Do we want to create that soon or push it off until things settle a bit more? ([[User:Willkg|Willkg]] 08:54, 10 November 2011 (EST))
* [[Feature Ideas]]: What should we do about the wiki page? Keep it and have it as a monthly topic for "what next"? Convert everything to long waiting bugs?
* Possibility of an [[SQL Database Backend]]?
*: 'executive summary' (well, you should read the long docs): "We could move to sql. It's probably replacing one type of pain by another type of pain, but those are somewhat comparable. Leaving the main question: Do we want to occupy our main devs for some long time with this task and loose momentum?"
* Schendje's [http://wiki.mediagoblin.org/Feature_Ideas/Activities activities proposal]
* "Coming up next" blogpost draft by Deb Nicholson
* Jef's requests:
** Ticket #466 "Use of "Submit" in site copy is sterile and not as friendly and welcoming as it could be". I'd really like to change this soon to something more suitable. How can we improve the wording here? Some alternatives have been mentioned in the bug report, but which one should we pick? Link: http://bugs.foocorp.net/issues/466
** The concept and naming of "favourites". We'll (hopefully) be able to "favourite" media soon, which I *think* means that 1) it'll work like a "I like this" comment, a quick token of appreciation, 2) it'll be added to your list of favourites so you can save and promote it, and 3) we could maybe use the number of favourites as a ranking. What I'd like to know is: is that the intended purpose? If so, should we name them favo(u)rites or something else? "Like", "love", "save", "appreciate", "heart", "high five" and many more could all be contenders. And the name should be consistent with the action and purpose, of course. So I'd like to clear up how and why we will use favourites and what we should call them.

=== 2011-11 (held on 2011-11-05) ===

[http://mediagoblin.org/irclogs/irc_meeting_2011-11-05.txt IRC log]

* What happened in the last month, what was good, what could be better next time?
** Release:
*** Good: 0.1.0 released!
*** Bad: postponing vs not postponing
** Sites and deployment documentation:
*** Good: new mediagoblin.org
*** Good: deployment documentation
*** Bad: py-bcrypt’s site was down just after the release, so the virtualenv deployment didn’t work, and it wasn’t clear how to fix it.
** Live instances:
*** Joar has a live instance!
*** But what does it mean? Should ordinary users start using it?
**** Details at [[User:Joar/mg.wandborg.se]] -- [[User:Joar|Joar]] 17:01, 6 November 2011 (EST)
*** nyergler added a note about "heartbeat"/status to API notes
* What should be done next month?
* Starting real work on federation (via OStatus)... and do we split any of this work out into its own library?
* An API
* Creative Commons licensing tools
* Merging in the multimedia/video branch
*: (this is *very close* already actually thanks to the hard work of Joar Wandborg! But we need some help on the gstreamer front to fix a few issues... if you or someone you know is an expert in this area we could really use their help to make the videos that come out smoother!)
* Rollover items from 0.1.0
* Multiple file upload interface
* Drag and drop uploads interface (probably related!)

=== 2011-10 (held on 2011-10-01) ===

[http://mediagoblin.org/irclogs/irc_meeting_2011-10-01.txt IRC log]

This month's meeting was a quickly announced short meeting. The project is getting back on track and next month's meeting will be scheduled more properly. A bunch of people were around.

The most important decisions:
* The project will keep monthly releases. They're the heartbeat of the project.
* Release 0.1.0 this sunday/monday.
* New website will hopefully be deployed in the next few days.
* And the following things are planned to happen during this month: Most importantly federation. The developers have decided to make up their minds on what federation aactually should mean for MediaGoblin. Concerning code, probably "activity streams" are the first goal. If there is no (good) python library for this, a new stand alone library may be created. If so, a name for it has to be found. It should have something about communication in it. And the other thing to happen during this month is an ongoing discussion about "bus factor".

=== 2011-09 (held on 2011-09-03) ===

[http://mediagoblin.org/irclogs/irc_meeting_2011-09-03.txt IRC log]

=== 2011-08 (held on 2011-08-06) ===

[http://mediagoblin.org/irclogs/irc_meeting_2011-08-06.txt IRC log]

HackingHowto

2011-12-11T22:02:44Z

ShawnRisk: /* How to set up and maintain an environment for hacking with virtualenv */

= Hacking HOWTO =

== So you want to hack on GNU MediaGoblin? ==

First thing to do is check out the [http://mediagoblin.org/join/ web site] where we list all the project
infrastructure including:

* the IRC channel
* the mailing list
* the issue tracker

Additionally, we have information on how to get involved, who to talk
to, what needs to be worked on, and other things besides!

Second thing to do is take a look at [http://docs.mediagoblin.org/codebase.html codebase chapter] where
we've started documenting how GNU MediaGoblin is built and how to add
new things.

Third you'll need to get the requirements.

Fourth, you'll need to build a development environment. We use an
in-package checkout of virtualenv. This isn't the convenional way to
install virtualenv (normally you don't install virtualenv inside the
package itself) but we've found that it's significantly easier for
newcomers who aren't already familiar with virtualenv. If you *are*
already familiar with virtualenv, feel free to just install
mediagoblin in your own virtualenv setup... the necessary adjustments
should be obvious.

== Getting requirements ==

First, you need to have the following installed before you can build
an environment for hacking on GNU MediaGoblin:

* Python 2.6 or 2.7 - http://www.python.org/ (You'll need Python as well as the dev files for building modules.)
* python-lxml - http://lxml.de/
* git - http://git-scm.com/
* MongoDB - http://www.mongodb.org/
* Python Imaging Library (PIL) - http://www.pythonware.com/products/pil/
* virtualenv - http://www.virtualenv.org/

Note, MongoDB can get to be pretty huge. You might want to consider
looking at [[Scaling Down]] if you are installing this on a smallish
instance.

=== GNU/Linux ===

==== Debian and derivatives ====

If you're running Debian GNU/Linux or a Debian-derived distribution
such as Debian, Mint, or [http://bugs.foocorp.net/issues/478 Ubuntu 10.10+], running the following should install these
requirements:

{{Cmd|sudo apt-get install mongodb git-core python python-dev python-lxml python-imaging python-virtualenv}}

==== Fedora / RedHat(?) ====

On Fedora:

{{Cmd|yum install mongodb-server python-paste-deploy python-paste-script git-core python python-devel python-lxml python-imaging python-virtualenv}}

=== Mac OS X ===

On Mac OS X Lion:

Download the Newest Python.

Git is already installed.

Install MongoDB from these instructions: http://www.mongodb.org/display/DOCS/Quickstart+OS+X

Python-lxml: http://muffinresearch.co.uk/archives/2009/03/05/install-lxml-on-osx/ with sudo

Python Imaging Library (PIL): http://code.google.com/appengine/docs/python/images/installingPIL.html#mac

Libjpeg & Libpng: http://ethan.tira-thompson.org/Mac_OS_X_Ports.html Combo Installer

----

'''You can help:'''

If you have instructions for other GNU/Linux distributions, Windows, or Mac OS X to set
up requirements, let us know!

== How to set up and maintain an environment for hacking with virtualenv ==

'''Requirements'''

No additional requirements.

'''Create a development environment'''

After installing the requirements, follow these steps:

# Clone the repository: {{Cmd|git clone <nowiki>git://gitorious.org/mediagoblin/mediagoblin.git</nowiki>}}
# Change directories to your new checkout: {{Cmd|cd mediagoblin}}
# Set up the in-package virtualenv: {{Cmd|virtualenv . && ./bin/python setup.py develop}}

That's it!

(If you have troubles in the remaining steps, consider try installing
virtualenv with one of the flags --setuptools, --distribute or possibly --no-site-packages. Additionally, if your system has python3.X as the default, you might need to do virtualenv --python=python2.7 or --python=python2.6)

If you have problems, please [http://mediagoblin.org/join/ let us know]!

'''Updating for dependency changes'''

While hacking on GNU MediaGoblin over time, you'll eventually have to
update your development environment because the dependencies have
changed.

To do that, run:

{{Cmd|./bin/python setup.py develop --upgrade && ./bin/gmg migrate}}

'''Updating for code changes'''

{{Cmd|git pull -u}}

== Running Mongo Database ==

Startup the Database if you haven't already. On most systems, this
should be started automatically. If not, consult the documentation
for your distribution or the MongoDB docs themselves.

== Running the server ==

If you want to get things running quickly and without hassle, just
run:

{{Cmd|./lazyserver.sh}}

This will start up a python server where you can begin playing with
mediagoblin, listening on 127.0.0.1:6543. It will also run celery in "always eager" mode so you
don't have to start a separate process for it.

By default, the instance is not sending out confirmation mails. Instead they are redirected to the standard output (the console) of lazyserver.sh.

You can change this behavior setting <code>email_debug_mode</code> to <code>false</code> in mediagoblin.ini

This is fine in development, but if you want to actually run celery
separately for testing (or deployment purposes), you'll want to run
the server independently:

{{Cmd|./bin/paster serve paste.ini --reload}}

== Running celeryd ==

If you aren't using <tt>./lazyserver.sh</tt> or otherwise aren't running celery
in always eager mode, you'll need to do this if you want your media to
process and actually show up. It's probably a good idea in
development to have the web server (above) running in one terminal and
celeryd in another window.

Run:

{{Cmd|<nowiki>CELERY_CONFIG_MODULE=mediagoblin.init.celery.from_celery ./bin/celeryd</nowiki>}}

== Running the test suite ==

Run:

{{Cmd|./runtests.sh}}

== Running a shell ==

If you want a shell with your database pre-setup and an instantiated
application ready and at your fingertips....

Run:

{{Cmd|./bin/gmg shell}}

== Troubleshooting ==

=== pymongo.errors.AutoReconnect: could not find master/primary ===

If you see this:

pymongo.errors.AutoReconnect: could not find master/primary

then make sure mongodb is installed and running.

If it's installed, check the mongodb log. On my machine, that's
<tt>/var/log/mongodb/mongodb.log</tt>. If you see something like:

old lock file: /var/lib/mongodb/mongod.lock. probably means...

in that case you might have had an unclean shutdown. Try:

{{Cmd|sudo mongod --repair}}

If that didn't work, just delete the lock file and relaunch mongodb.

Anyway, then start the mongodb server in whatever way is appropriate
for your distro / OS.

== Wiping your user data ==

You can completely wipe all data from the instance by doing:

{{Cmd|gmg wipealldata}}

'''Note:'''

Unless you're doing development and working on and testing creating
a new instance, you will probably never have to do this. Will
plans to do this work and thus he documented it.

== Quickstart for Django programmers ==

We're not using Django, but the codebase is very Django-like in its
structure.

* <tt>routing.py</tt> is like <tt>urls.py</tt> in Django
* <tt>models.py</tt> has mongokit ORM definitions
* <tt>views.py</tt> is where the views go

We're using MongoDB. Basically, instead of a relational database with
tables, you have a big JSON structure which acts a lot like a Python
dict.

'''YouCanHelp'''

If there are other things that you think would help orient someone
new to GNU MediaGoblin but coming from Django, let us know!

== Bite-sized bugs to start with ==

Now you should visit our latest list of [http://bugs.foocorp.net/projects/mediagoblin/issues?query_id=3 bite-sized issues] because squishing bugs is messy fun. If you're interested in other things to work on, or need help getting started on a bug, let us know on [http://mediagoblin.org/join/ the mailing list] or on the [http://mediagoblin.org/join/ IRC channel].

HackingHowto

2011-08-17T15:54:37Z

ShawnRisk:

= Hacking HOWTO =

== So you want to hack on GNU MediaGoblin? ==

First thing to do is check out the [http://mediagoblin.org/join/ web site] where we list all the project
infrastructure including:

* the IRC channel
* the mailing list
* the issue tracker

Additionally, we have information on how to get involved, who to talk
to, what needs to be worked on, and other things besides!

Second thing to do is take a look at :ref:`codebase-chapter` where
we've started documenting how GNU MediaGoblin is built and how to add
new things.

Third you'll need to get the requirements.

Fourth, you'll need to build a development environment. We use buildout,
but if you want to use virtualenv, there's a set of mediocre not-very-supported
steps in the [https://gitorious.org/mediagoblin/pages/Home evil wiki].

== Getting requirements ==

First, you need to have the following installed before you can build
an environment for hacking on GNU MediaGoblin:

* Python 2.6 or 2.7 - http://www.python.org/ (You'll need Python as well as the dev files for building modules.)
* python-lxml - http://lxml.de/
* git - http://git-scm.com/
* MongoDB - http://www.mongodb.org/
* Python Imaging Library (PIL) - http://www.pythonware.com/products/pil/

If you're running Debian GNU/Linux or a Debian-derived distribution
such as Debian, Mint, or [http://bugs.foocorp.net/issues/478 Ubuntu 10.10+], running the following should install these
requirements:

{{Cmd|sudo apt-get install mongodb git-core python python-dev python-lxml python-imaging}}

On Fedora:

{{Cmd|yum install mongodb-server python-paste-deploy python-paste-script git-core python python-devel python-lxml python-imaging}}

----

On Mac OS X Lion:

Download the Newest Python.

Git is already installed.

Install MongoDB from these instructions: http://www.mongodb.org/display/DOCS/Quickstart+OS+X

Python-lxml: http://muffinresearch.co.uk/archives/2009/03/05/install-lxml-on-osx/ with sudo

Python Imaging Library (PIL): http://code.google.com/appengine/docs/python/images/installingPIL.html#mac

Libjpeg & Libpng: http://ethan.tira-thompson.org/Mac_OS_X_Ports.html Combo Installer

----

'''You can help:'''

If you have instructions for other GNU/Linux distributions or Mac OS X to set
up requirements, let us know!

== How to set up and maintain an environment for hacking with buildout ==

'''Requirements'''

No additional requirements.

'''Create a development environment'''

After installing the requirements, follow these steps:

# Clone the repository: {{Cmd|git clone <nowiki>git://gitorious.org/mediagoblin/mediagoblin.git</nowiki>}}
# Bootstrap and run buildout: {{Cmd|cd mediagoblin}} and then one of the following:
#* {{Cmd|python bootstrap.py && ./bin/buildout}}, '''OR'''
#* {{Cmd|python bootstrap.py --distribute && ./bin/buildout}}

Why would you want one over the other? If the first doesn't work, then try the second.

That's it! Using this method, buildout should create a <tt>user_dev</tt>
directory, in which certain things will be stored (media, beaker
session stuff, etc). You can change this, but for development
purposes this default should be fine.

If you have problems, please [http://mediagoblin.org/join/ let us know]!

'''Updating for dependency changes'''

While hacking on GNU MediaGoblin over time, you'll eventually have to
update your development environment because the dependencies have
changed.

To do that, run:

{{Cmd|./bin/buildout && ./bin/gmg migrate}}.

'''Updating for code changes'''

You don't need to do anything---code changes are automatically available.

'''Deleting your buildout'''

At some point, you may want to delete your buildout. Perhaps it's to
start over. Perhaps it's to test building development environments
with buildout.

To do this, run:

{{Cmd|rm -rf bin develop-eggs eggs mediagoblin.egg-info parts user_dev}}.

== Running Mongo Database ==

Startup the Database: {{Cmd|./mongodb-xxxxxxx/bin/mongod}}.

== Running the server ==

If you want to get things running quickly and without hassle, just
run:

{{Cmd|./lazyserver.sh}}.

This will start up a python server where you can begin playing with
mediagoblin. It will also run celery in "always eager" mode so you
don't have to start a separate process for it.

This is fine in development, but if you want to actually run celery
separately for testing (or deployment purposes), you'll want to run
the server independently:

{{Cmd|./bin/paster serve paste.ini --reload}}

== Running celeryd ==

If you aren't using <tt>./lazyserver.sh</tt> or otherwise aren't running celery
in always eager mode, you'll need to do this if you want your media to
process and actually show up. It's probably a good idea in
development to have the web server (above) running in one terminal and
celeryd in another window.

Run:

{{Cmd|<nowiki>CELERY_CONFIG_MODULE=mediagoblin.init.celery.from_celery ./bin/celeryd</nowiki>}}.

== Running the test suite ==

Run:

{{Cmd|./runtests.sh}}

== Running a shell ==

If you want a shell with your database pre-setup and an instantiated
application ready and at your fingertips....

Run:

{{Cmd|./bin/gmg shell}}

== Troubleshooting ==

=== pymongo.errors.AutoReconnect: could not find master/primary ===

If you see this:

pymongo.errors.AutoReconnect: could not find master/primary

then make sure mongodb is installed and running.

If it's installed, check the mongodb log. On my machine, that's
<tt>/var/log/mongodb/mongodb.log</tt>. If you see something like:

old lock file: /var/lib/mongodb/mongod.lock. probably means...

in that case you might have had an unclean shutdown. Try:

{{Cmd|sudo mongod --repair}}

If that didn't work, just delete the lock file and relaunch mongodb.

Anyway, then start the mongodb server in whatever way is appropriate
for your distro / OS.

== Wiping your user data ==

You can completely wipe all data from the instance by doing:

{{Cmd|gmg wipealldata}}

'''Note:'''

Unless you're doing development and working on and testing creating
a new instance, you will probably never have to do this. Will
plans to do this work and thus he documented it.

== Quickstart for Django programmers ==

We're not using Django, but the codebase is very Django-like in its
structure.

* <tt>routing.py</tt> is like <tt>urls.py</tt> in Django
* <tt>models.py</tt> has mongokit ORM definitions
* <tt>views.py</tt> is where the views go

We're using MongoDB. Basically, instead of a relational database with
tables, you have a big JSON structure which acts a lot like a Python
dict.

'''YouCanHelp'''

If there are other things that you think would help orient someone
new to GNU MediaGoblin but coming from Django, let us know!

== Bite-sized bugs to start with ==

'''May 3rd, 2011''': We don't have a list of bite-sized bugs, yet, but
this is important to us. If you're interested in things to work on,
let us know on [http://mediagoblin.org/join/ the mailing list] or
on the [http://mediagoblin.org/join/ IRC channel].

== Tips for people new to coding ==

=== Learning Python ===

GNU MediaGoblin is written using a programming language called [http://python.org/ Python].

There are two different incompatible iterations of Python which I'll
refer to as Python 2 and Python 3. GNU MediaGoblin is written in
Python 2 and requires Python 2.6 or 2.7. At some point, we might
switch to Python 3, but that's a future thing.

You can learn how to code in Python 2 from several excellent books
that are freely available on the Internet:

* [http://learnpythonthehardway.org/ Learn Python the Hard Way]
* [http://diveintopython.org/ Dive Into Python]
* [http://www.greenteapress.com/thinkpython/ Python for Software Design]
* [http://www.swaroopch.com/notes/Python A Byte of Python]

These are all excellent texts.

'''You Can Help'''

If you know of other good quality Python tutorials and Python
tutorial videos, let us know!

=== Learning Libraries GNU MediaGoblin uses ===

GNU MediaGoblin uses a variety of libraries in order to do what it
does. These libraries are listed in the :ref:`codebase-chapter`
along with links to the project Web sites and documentation for the
libraries.

There are a variety of Python-related conferences every year that have
sessions covering many aspects of these libraries. You can find them
at [http://python.mirocommunity.org Python Miro Community] -- This is a shameless plug; Will Kahn-Greene runs Python Miro Community.

If you have questions or need help, [http://mediagoblin.org/join/ let us know]!

=== Learning git ===

git is an interesting and very powerful tool. Like all powerful
tools, it has a learning curve.

If you're new to git, we highly recommend the following resources for
getting the hang of it:

* [http://learn.github.com/p/intro.html Learn Git] --- the GitHub intro to git
* [http://progit.org/book/ Pro Git] --- fantastic book
* [http://gitcasts.com/ Git casts] --- screencast covering git usage
* [http://gitref.org/ Git Reference] --- Git reference that makes it easier to get the hang of git if you're coming from other version control systems

There's also a git mission at [http://openhatch.org/ OpenHatch].

=== Learning other utilities ===

The [http://openhatch.org/ OpenHatch] site has a series of
[http://openhatch.org/missions/ training missions] which are
designed to help you learn how to use these tools.

If you're new to tar, diff, patch and git, we highly recommend you sign
up with OpenHatch and do the missions.

HackingHowto

2011-08-17T15:15:45Z

ShawnRisk:

= Hacking HOWTO =

== So you want to hack on GNU MediaGoblin? ==

First thing to do is check out the [http://mediagoblin.org/join/ web site] where we list all the project
infrastructure including:

* the IRC channel
* the mailing list
* the issue tracker

Additionally, we have information on how to get involved, who to talk
to, what needs to be worked on, and other things besides!

Second thing to do is take a look at :ref:`codebase-chapter` where
we've started documenting how GNU MediaGoblin is built and how to add
new things.

Third you'll need to get the requirements.

Fourth, you'll need to build a development environment. We use buildout,
but if you want to use virtualenv, there's a set of mediocre not-very-supported
steps in the [https://gitorious.org/mediagoblin/pages/Home evil wiki].

== Getting requirements ==

First, you need to have the following installed before you can build
an environment for hacking on GNU MediaGoblin:

* Python 2.6 or 2.7 - http://www.python.org/ (You'll need Python as well as the dev files for building modules.)
* python-lxml - http://lxml.de/
* git - http://git-scm.com/
* MongoDB - http://www.mongodb.org/
* Python Imaging Library (PIL) - http://www.pythonware.com/products/pil/

If you're running Debian GNU/Linux or a Debian-derived distribution
such as Debian, Mint, or [http://bugs.foocorp.net/issues/478 Ubuntu 10.10+], running the following should install these
requirements:

{{Cmd|sudo apt-get install mongodb git-core python python-dev python-lxml python-imaging}}

On Fedora:

{{Cmd|yum install mongodb-server python-paste-deploy python-paste-script git-core python python-devel python-lxml}}

----

On Mac OS X Lion:

Download the Newest Python.

Git is already installed.

Install MongoDB from these instructions: http://www.mongodb.org/display/DOCS/Quickstart+OS+X

Python-lxml: http://muffinresearch.co.uk/archives/2009/03/05/install-lxml-on-osx/ with sudo

Python Imaging Library (PIL): http://code.google.com/appengine/docs/python/images/installingPIL.html#mac

----

'''You can help:'''

If you have instructions for other GNU/Linux distributions or Mac OS X to set
up requirements, let us know!

== How to set up and maintain an environment for hacking with buildout ==

'''Requirements'''

No additional requirements.

'''Create a development environment'''

After installing the requirements, follow these steps:

# Clone the repository: {{Cmd|git clone <nowiki>git://gitorious.org/mediagoblin/mediagoblin.git</nowiki>}}
# Bootstrap and run buildout: {{Cmd|cd mediagoblin}} and then one of the following:
#* {{Cmd|python bootstrap.py && ./bin/buildout}}, '''OR'''
#* {{Cmd|python bootstrap.py --distribute && ./bin/buildout}}

Why would you want one over the other? If the first doesn't work, then try the second.

That's it! Using this method, buildout should create a <tt>user_dev</tt>
directory, in which certain things will be stored (media, beaker
session stuff, etc). You can change this, but for development
purposes this default should be fine.

If you have problems, please [http://mediagoblin.org/join/ let us know]!

'''Updating for dependency changes'''

While hacking on GNU MediaGoblin over time, you'll eventually have to
update your development environment because the dependencies have
changed.

To do that, run:

{{Cmd|./bin/buildout && ./bin/gmg migrate}}.

'''Updating for code changes'''

You don't need to do anything---code changes are automatically available.

'''Deleting your buildout'''

At some point, you may want to delete your buildout. Perhaps it's to
start over. Perhaps it's to test building development environments
with buildout.

To do this, run:

{{Cmd|rm -rf bin develop-eggs eggs mediagoblin.egg-info parts user_dev}}.

== Running Mongo Database ==

Startup the Database: {{Cmd|./mongodb-xxxxxxx/bin/mongod}}.

== Running the server ==

If you want to get things running quickly and without hassle, just
run:

{{Cmd|./lazyserver.sh}}.

This will start up a python server where you can begin playing with
mediagoblin. It will also run celery in "always eager" mode so you
don't have to start a separate process for it.

This is fine in development, but if you want to actually run celery
separately for testing (or deployment purposes), you'll want to run
the server independently:

{{Cmd|./bin/paster serve paste.ini --reload}}

== Running celeryd ==

If you aren't using <tt>./lazyserver.sh</tt> or otherwise aren't running celery
in always eager mode, you'll need to do this if you want your media to
process and actually show up. It's probably a good idea in
development to have the web server (above) running in one terminal and
celeryd in another window.

Run:

{{Cmd|<nowiki>CELERY_CONFIG_MODULE=mediagoblin.init.celery.from_celery ./bin/celeryd</nowiki>}}.

== Running the test suite ==

Run:

{{Cmd|./runtests.sh}}

== Running a shell ==

If you want a shell with your database pre-setup and an instantiated
application ready and at your fingertips....

Run:

{{Cmd|./bin/gmg shell}}

== Troubleshooting ==

=== pymongo.errors.AutoReconnect: could not find master/primary ===

If you see this:

pymongo.errors.AutoReconnect: could not find master/primary

then make sure mongodb is installed and running.

If it's installed, check the mongodb log. On my machine, that's
<tt>/var/log/mongodb/mongodb.log</tt>. If you see something like:

old lock file: /var/lib/mongodb/mongod.lock. probably means...

in that case you might have had an unclean shutdown. Try:

{{Cmd|sudo mongod --repair}}

If that didn't work, just delete the lock file and relaunch mongodb.

Anyway, then start the mongodb server in whatever way is appropriate
for your distro / OS.

== Wiping your user data ==

You can completely wipe all data from the instance by doing:

{{Cmd|gmg wipealldata}}

'''Note:'''

Unless you're doing development and working on and testing creating
a new instance, you will probably never have to do this. Will
plans to do this work and thus he documented it.

== Quickstart for Django programmers ==

We're not using Django, but the codebase is very Django-like in its
structure.

* <tt>routing.py</tt> is like <tt>urls.py</tt> in Django
* <tt>models.py</tt> has mongokit ORM definitions
* <tt>views.py</tt> is where the views go

We're using MongoDB. Basically, instead of a relational database with
tables, you have a big JSON structure which acts a lot like a Python
dict.

'''YouCanHelp'''

If there are other things that you think would help orient someone
new to GNU MediaGoblin but coming from Django, let us know!

== Bite-sized bugs to start with ==

'''May 3rd, 2011''': We don't have a list of bite-sized bugs, yet, but
this is important to us. If you're interested in things to work on,
let us know on [http://mediagoblin.org/join/ the mailing list] or
on the [http://mediagoblin.org/join/ IRC channel].

== Tips for people new to coding ==

=== Learning Python ===

GNU MediaGoblin is written using a programming language called [http://python.org/ Python].

There are two different incompatible iterations of Python which I'll
refer to as Python 2 and Python 3. GNU MediaGoblin is written in
Python 2 and requires Python 2.6 or 2.7. At some point, we might
switch to Python 3, but that's a future thing.

You can learn how to code in Python 2 from several excellent books
that are freely available on the Internet:

* [http://learnpythonthehardway.org/ Learn Python the Hard Way]
* [http://diveintopython.org/ Dive Into Python]
* [http://www.greenteapress.com/thinkpython/ Python for Software Design]
* [http://www.swaroopch.com/notes/Python A Byte of Python]

These are all excellent texts.

'''You Can Help'''

If you know of other good quality Python tutorials and Python
tutorial videos, let us know!

=== Learning Libraries GNU MediaGoblin uses ===

GNU MediaGoblin uses a variety of libraries in order to do what it
does. These libraries are listed in the :ref:`codebase-chapter`
along with links to the project Web sites and documentation for the
libraries.

There are a variety of Python-related conferences every year that have
sessions covering many aspects of these libraries. You can find them
at [http://python.mirocommunity.org Python Miro Community] -- This is a shameless plug; Will Kahn-Greene runs Python Miro Community.

If you have questions or need help, [http://mediagoblin.org/join/ let us know]!

=== Learning git ===

git is an interesting and very powerful tool. Like all powerful
tools, it has a learning curve.

If you're new to git, we highly recommend the following resources for
getting the hang of it:

* [http://learn.github.com/p/intro.html Learn Git] --- the GitHub intro to git
* [http://progit.org/book/ Pro Git] --- fantastic book
* [http://gitcasts.com/ Git casts] --- screencast covering git usage
* [http://gitref.org/ Git Reference] --- Git reference that makes it easier to get the hang of git if you're coming from other version control systems

There's also a git mission at [http://openhatch.org/ OpenHatch].

=== Learning other utilities ===

The [http://openhatch.org/ OpenHatch] site has a series of
[http://openhatch.org/missions/ training missions] which are
designed to help you learn how to use these tools.

If you're new to tar, diff, patch and git, we highly recommend you sign
up with OpenHatch and do the missions.

HackingHowto

2011-08-17T14:39:38Z

ShawnRisk:

= Hacking HOWTO =

== So you want to hack on GNU MediaGoblin? ==

First thing to do is check out the [http://mediagoblin.org/join/ web site] where we list all the project
infrastructure including:

* the IRC channel
* the mailing list
* the issue tracker

Additionally, we have information on how to get involved, who to talk
to, what needs to be worked on, and other things besides!

Second thing to do is take a look at :ref:`codebase-chapter` where
we've started documenting how GNU MediaGoblin is built and how to add
new things.

Third you'll need to get the requirements.

Fourth, you'll need to build a development environment. We use buildout,
but if you want to use virtualenv, there's a set of mediocre not-very-supported
steps in the [https://gitorious.org/mediagoblin/pages/Home evil wiki].

== Getting requirements ==

First, you need to have the following installed before you can build
an environment for hacking on GNU MediaGoblin:

* Python 2.6 or 2.7 - http://www.python.org/ (You'll need Python as well as the dev files for building modules.)
* python-lxml - http://lxml.de/
* git - http://git-scm.com/
* MongoDB - http://www.mongodb.org/

If you're running Debian GNU/Linux or a Debian-derived distribution
such as Debian, Mint, or [http://bugs.foocorp.net/issues/478 Ubuntu 10.10+], running the following should install these
requirements:

{{Cmd|sudo apt-get install mongodb git-core python python-dev python-lxml python-imaging}}

On Fedora:

{{Cmd|yum install mongodb-server python-paste-deploy python-paste-script git-core python python-devel python-lxml}}

----

On Mac OS X Lion:

Download the Newest Python.

Git is already installed.

Install MongoDB from these instructions: http://www.mongodb.org/display/DOCS/Quickstart+OS+X

For Python-lxml: http://muffinresearch.co.uk/archives/2009/03/05/install-lxml-on-osx/ with sudo

----

'''You can help:'''

If you have instructions for other GNU/Linux distributions or Mac OS X to set
up requirements, let us know!

== How to set up and maintain an environment for hacking with buildout ==

'''Requirements'''

No additional requirements.

'''Create a development environment'''

After installing the requirements, follow these steps:

# Clone the repository: {{Cmd|git clone <nowiki>git://gitorious.org/mediagoblin/mediagoblin.git</nowiki>}}
# Bootstrap and run buildout: {{Cmd|cd mediagoblin}} and then one of the following:
#* {{Cmd|python bootstrap.py && ./bin/buildout}}, '''OR'''
#* {{Cmd|python bootstrap.py --distribute && ./bin/buildout}}

Why would you want one over the other? If the first doesn't work, then try the second.

That's it! Using this method, buildout should create a <tt>user_dev</tt>
directory, in which certain things will be stored (media, beaker
session stuff, etc). You can change this, but for development
purposes this default should be fine.

If you have problems, please [http://mediagoblin.org/join/ let us know]!

'''Updating for dependency changes'''

While hacking on GNU MediaGoblin over time, you'll eventually have to
update your development environment because the dependencies have
changed.

To do that, run:

{{Cmd|./bin/buildout && ./bin/gmg migrate}}.

'''Updating for code changes'''

You don't need to do anything---code changes are automatically available.

'''Deleting your buildout'''

At some point, you may want to delete your buildout. Perhaps it's to
start over. Perhaps it's to test building development environments
with buildout.

To do this, run:

{{Cmd|rm -rf bin develop-eggs eggs mediagoblin.egg-info parts user_dev}}.

== Running Mongo Database ==

Startup the Database: {{Cmd|./mongodb-xxxxxxx/bin/mongod}}.

== Running the server ==

If you want to get things running quickly and without hassle, just
run:

{{Cmd|./lazyserver.sh}}.

This will start up a python server where you can begin playing with
mediagoblin. It will also run celery in "always eager" mode so you
don't have to start a separate process for it.

This is fine in development, but if you want to actually run celery
separately for testing (or deployment purposes), you'll want to run
the server independently:

{{Cmd|./bin/paster serve paste.ini --reload}}

== Running celeryd ==

If you aren't using <tt>./lazyserver.sh</tt> or otherwise aren't running celery
in always eager mode, you'll need to do this if you want your media to
process and actually show up. It's probably a good idea in
development to have the web server (above) running in one terminal and
celeryd in another window.

Run:

{{Cmd|<nowiki>CELERY_CONFIG_MODULE=mediagoblin.init.celery.from_celery ./bin/celeryd</nowiki>}}.

== Running the test suite ==

Run:

{{Cmd|./runtests.sh}}

== Running a shell ==

If you want a shell with your database pre-setup and an instantiated
application ready and at your fingertips....

Run:

{{Cmd|./bin/gmg shell}}

== Troubleshooting ==

=== pymongo.errors.AutoReconnect: could not find master/primary ===

If you see this:

pymongo.errors.AutoReconnect: could not find master/primary

then make sure mongodb is installed and running.

If it's installed, check the mongodb log. On my machine, that's
<tt>/var/log/mongodb/mongodb.log</tt>. If you see something like:

old lock file: /var/lib/mongodb/mongod.lock. probably means...

in that case you might have had an unclean shutdown. Try:

{{Cmd|sudo mongod --repair}}

If that didn't work, just delete the lock file and relaunch mongodb.

Anyway, then start the mongodb server in whatever way is appropriate
for your distro / OS.

== Wiping your user data ==

You can completely wipe all data from the instance by doing:

{{Cmd|gmg wipealldata}}

'''Note:'''

Unless you're doing development and working on and testing creating
a new instance, you will probably never have to do this. Will
plans to do this work and thus he documented it.

== Quickstart for Django programmers ==

We're not using Django, but the codebase is very Django-like in its
structure.

* <tt>routing.py</tt> is like <tt>urls.py</tt> in Django
* <tt>models.py</tt> has mongokit ORM definitions
* <tt>views.py</tt> is where the views go

We're using MongoDB. Basically, instead of a relational database with
tables, you have a big JSON structure which acts a lot like a Python
dict.

'''YouCanHelp'''

If there are other things that you think would help orient someone
new to GNU MediaGoblin but coming from Django, let us know!

== Bite-sized bugs to start with ==

'''May 3rd, 2011''': We don't have a list of bite-sized bugs, yet, but
this is important to us. If you're interested in things to work on,
let us know on [http://mediagoblin.org/join/ the mailing list] or
on the [http://mediagoblin.org/join/ IRC channel].

== Tips for people new to coding ==

=== Learning Python ===

GNU MediaGoblin is written using a programming language called [http://python.org/ Python].

There are two different incompatible iterations of Python which I'll
refer to as Python 2 and Python 3. GNU MediaGoblin is written in
Python 2 and requires Python 2.6 or 2.7. At some point, we might
switch to Python 3, but that's a future thing.

You can learn how to code in Python 2 from several excellent books
that are freely available on the Internet:

* [http://learnpythonthehardway.org/ Learn Python the Hard Way]
* [http://diveintopython.org/ Dive Into Python]
* [http://www.greenteapress.com/thinkpython/ Python for Software Design]
* [http://www.swaroopch.com/notes/Python A Byte of Python]

These are all excellent texts.

'''You Can Help'''

If you know of other good quality Python tutorials and Python
tutorial videos, let us know!

=== Learning Libraries GNU MediaGoblin uses ===

GNU MediaGoblin uses a variety of libraries in order to do what it
does. These libraries are listed in the :ref:`codebase-chapter`
along with links to the project Web sites and documentation for the
libraries.

There are a variety of Python-related conferences every year that have
sessions covering many aspects of these libraries. You can find them
at [http://python.mirocommunity.org Python Miro Community] -- This is a shameless plug; Will Kahn-Greene runs Python Miro Community.

If you have questions or need help, [http://mediagoblin.org/join/ let us know]!

=== Learning git ===

git is an interesting and very powerful tool. Like all powerful
tools, it has a learning curve.

If you're new to git, we highly recommend the following resources for
getting the hang of it:

* [http://learn.github.com/p/intro.html Learn Git] --- the GitHub intro to git
* [http://progit.org/book/ Pro Git] --- fantastic book
* [http://gitcasts.com/ Git casts] --- screencast covering git usage
* [http://gitref.org/ Git Reference] --- Git reference that makes it easier to get the hang of git if you're coming from other version control systems

There's also a git mission at [http://openhatch.org/ OpenHatch].

=== Learning other utilities ===

The [http://openhatch.org/ OpenHatch] site has a series of
[http://openhatch.org/missions/ training missions] which are
designed to help you learn how to use these tools.

If you're new to tar, diff, patch and git, we highly recommend you sign
up with OpenHatch and do the missions.