For the last part of my internship, I’m adding a search function to the Java Wiki Bot Framework. Unfortunately, the Java ecosystem has had other ideas. JWBF uses Maven, a common build automator and dependency manager, and I’ve had a difficult time getting it working on my own system. (I wrote about the things I tried here.)

Partly because of the frustration of getting such a simple program up and running and partly because it’s been a decade since I used anything besides a scripting language, I’ve had a hard time getting myself to work on the project itself. Tonight I jumped into the Java method problems at Coding Bat. It’s all online so there’s no need to struggle with classpaths or system-specific differences. I’ve been enjoying it, kind of like I enjoy working math where I know the steps, or enjoy balancing redox equations.

Note to self: doing little bits of code practice is kind of like washing up the glassware you know you’ll need so you can just get started on the next reaction whenever the one running decides it’s done. Gather ye momentum where ye may.

I’ve been looking at web API client libraries in a lot of languages for my OPW internship project: Python, Perl, Ruby, and most recently, Java. Fortunately for me, the Java Wiki Bot Framework (JWBF) is the clear leader in the available libraries, so it was the only one on my list to evaluate.

That evaluation was challenging! I hadn’t written or read any Java since my first CS class–about a decade ago now. Since then, I’ve been working with interpreted languages, not compiled ones (see: Python, Perl, Ruby). The idea of dependencies becoming relevant at compile-time was strange to me (what, you can’t just check whether it’s installed properly with import jwbf?!). I’d never used Maven, and the project-based structure with a zillion subfolders was not intuitive. Auto-generated documentation (JavaDocs) were available, but it wasn’t clear what was expected from one (not to mention what a good one was.

I’ve learned a lot since I started wrestling with this. I now know about:

  • Limitations of JavaDocs. Basically: good for granular description of packages and methods, but your project should really have a separate larger-scale document that talks about design goals and the overall approach behind your implementation.
  • The internal structure of JWBF. mediawiki/actions is where most of the methods you’ll want your bot to use are kept.
  • What the deal with Maven is. Turns out it’s not an IDE, but rather a build automator and a dependency manager. It connects to Maven Central, an online repository that a lot of dependencies can be downloaded from.
  • How to start a project in Maven, how it handles dependencies, and (broadly) how I might use JWBF vs. hack on JWBF.

I also found a handful of debugging links (using the Eclipse IDE), which I haven’t tried myself yet. They’re on the table for next week’s work.

I have about two weeks left in my internship, and in that time I’ll make a handful of improvements for the project. I’ve already starting rewriting the README to be friendlier to and more informative for new Java developers, and soon I’ll start drafting a higher-level supplement to the JavaDocs, including information on which packages a MediaWiki API client developer should start with. Code-wise, I’ll be implementing a search function to address this feature request and writing the tests and documentation to support it.

Since I’ve reached the part of my internship where I need to evaluate a Ruby web API client library and had never written Ruby, I went looking for places to learn! Some of these are books, some are websites, some are web tutorials. All are online and free. If you’re new to Ruby, give these a shot!

Books:

Ruby Best Practices: http://cdn.oreillystatic.com/oreilly/booksamplers/7_Ruby_Best_Practices_Sampler.pdf
Previously available for free at http://blog.rubybestpractices.com/. The author is now working on Practicing Ruby: https://practicingruby.com/
Interesting links from Practicing Ruby: https://practicingruby.com/articles/meditations-on-bad-and-good-code-1 and https://practicingruby.com/articles/meditations-on-bad-and-good-code-2 .

Programming Ruby: The Pragmatic Programmer’s Guide: http://ruby-doc.com/docs/ProgrammingRuby/
When people talk about “pickaxe book” this is the one they’re talking about! This version is fairly dated:
“This book documents Version 1.6 of Ruby, which was released in September 2000.”

Why’s (Poignant) Guide To Ruby: http://mislav.uniqpath.com/poignant-guide/book/
If you want an off-the-wall introduction to Ruby, this one has cartoon foxes.

Mr. Neighborly’s Humble Little Ruby Book: http://www.humblelittlerubybook.com/

Learn Ruby The Hard Way: http://ruby.learncodethehardway.org/book/

Web-based tutorials:

Ruby Koans: http://rubykoans.com/
Make things work! Also downloadable.

Try Ruby: http://tryruby.org/
More in-browser Ruby tutorials.

Codeacademy’s Ruby module: http://www.codecademy.com/tracks/ruby
Interactive web-based Ruby lessons.

RubyWarrior: https://www.bloc.io/ruby-warrior/#/
Adorable game where you write Ruby code to move your warrior and defeat enemies.

Misc:
A MIT OpenCourseWare handout that has a no-frills guide to some basics and talks about differences between Ruby and Python: http://ocw.mit.edu/courses/electrical-engineering-and-computer-science/6-170-software-studio-spring-2013/recitations/MIT6_170S13_rec3-Ruby.pdf

Ruby Style Guide: https://github.com/bbatsov/ruby-style-guide . I’ve been told that this is as close as the Ruby community gets to consensus on what “good Ruby” looks like.

command line ruby cheat sheets: http://cheat.errtheblog.com/s/rvm

Ruby Cookbook is not freely available, but the all the code from the book is: http://www.crummy.com/writing/RubyCookbook/

Ruby is definitely not what I am used to, but it seems like an interesting language and I’m looking forward to learning more of it when I have more time.

When I decided to start working in tech, I knew that someday I’d find my place in the informal women-in-tech backchannel warning system.

It seems that I’ve already reached a place where I can practice two kinds of post-conference networking: the standard mild awkwardness of “Hello! Remember those interests we share? I think you are a professionally interesting person!” but also “Hey, heads up–I’ve been made aware that a person you socialized with has a history of sexually assaulting incapacitated women, and thought you might want to know.”

I knew I’d get here sooner or later.

I wish I’d been able to finish my first internship before I did.

I was honored to give the final keynote at last week’s Open Source Bridge 2014. My talk was titled “‘Why are these people following me?': Leadership for the introverted, uncertain, and astonished”. It is the story of how I learned and claimed my leadership skills–because leading and conveying authenticity are both learnable skills.

This talk contains brief and nonspecific mentions of emotional abuse and thoughts of suicide. The video skips in several places; I’ve filled in the transcript to the best of my memory, but if you happen to have more complete notes or corrections send them my way!

Video and transcript are below the fold. This talk is licensed CC-BY-SA.

Read the rest of this entry »

I am not back from WikiConference USA 2014, but I am settled in here to work and decompress for a few days. I attended the conference to give an intro-level talk and workshop based on my own work getting up to speed with the MediaWiki API, and to meet more of the larger Wikimedia community. I also got the chance to meet technical contributors whom I’d previously only interacted with on IRC and the wikitech-l mailing list. It’s good to be able to put faces to usernames. I also chatted with Asaf Bartov, a contributor to Mediawiki::Gateway. Asaf confirmed my first impressions of the library’s scope and quality–a good check for my work.

So, the talk! If you’re interested in the basics of web APIs (or MediaWiki’s in particular), my slides are available on Wikimedia Commons. Video for the talks will be up soon–see the WikiConference USA 2014 category for more photos.

Slides for talk
Slides for workshop/demo

I aimed the talk at an audience that was not wholly nontechnical but that would include non-programmers. Based on this feedback, it looks like I succeeded! https://twitter.com/kos2/status/472415903993589761https://twitter.com/kos2/status/472415903993589761

More highlights of the conference:

Sunday was the open space/unconference day. We started off with lightning talks (I talked about the Seattle Attic as a feminist hackerspace) and then I attended Sumana’s Diversity/Ally Skills training, using the Ada Initiative’s publicly licensed materials. We had about an hour until the next round of lightning talks (very cool stuff: Book scanners! Publicly available Israeli laws! 5-shot method of shooting video! Gender visualizations! Wikidata and maps!) so we only got through a couple of scenarios. The attendees at the Ally Skills training had wanted to keep going, so I agreed to lead another session in the afternoon.

It was an interesting experience, and it sounded like many of the attendees got a lot out of it. It was surprisingly/not surprisingly emotionally draining to run but I was glad to be able to offer this. The workshop offers concrete suggestions about how to deal with sexist words and actions as they come up, as well as some basic feminist background for people who may never have considered how some of these principles apply to their own life, and does it in the format of private small-group discussions. I am grateful to everyone who participated, shared, and listened in both of the sessions yesterday. I suspect that those conversations gave many of us things to think about. They certainly did to me.

This summer I’m taking part in the Outreach Program for Women, working on making the MediaWiki API more usable. As a part of this, I’ll be blogging every week or two with things I’ve done, things I’ve learned, or general thoughts as I get into the free/open source software world.

This is the second in a series on the MediaWiki API. Click here for previous post.

What is an API? “API” is short for Application Programming Interface, which is not much more informative. Broadly, APIs make it easy for programs to interact with each other–which is to say, they make it easy for programmers to incorporate a different program’s functionality into the program they’re writing.

This article on APIs by Brian Proffitt clearly describes the most important ways APIs work:

APIs… “[expose]” some of a program’s internal functions to the outside world in a limited fashion. That makes it possible for applications to share data and take actions on one another’s behalf without requiring developers to share all of their software’s code. Code-sharing on that scale wouldn’t just ruffle the feathers of programmers who’d rather keep it secret; it would also be grossly inefficient.

That’s true even for open-source programs. Who has the time to comb through all the code for somebody else’s application—which, trust me, can be awfully messy—just to use one function? (It’s also possible to run into tricky licensing issues if you’re not careful.)

APIs simplify all that by limiting outside program access to a specific set of features—often enough, requests for data of one sort or another. Feel free to think of them as doors, windows or levers if you like. Whatever the metaphor, APIs clearly define exactly how a program will interact with the rest of the software world—saving time, resources and potentially nasty legal entanglements along the way.

That’s the general concept behind APIs. Web APIs are similar, but made for the internet: they’re a way to fetch data from the database behind a website.

When you use a web browser to go to a website, your web browser makes an HTTP request to the server the page is stored on. The server, in turn, sends you data in the form of a web page: information in text/video/graphical form, arranged so that humans can easily understand it. You are now free to read the article/look at kitten pictures/write and post your blog post/watch that awesome fanvid.

When you write a program that uses a web API to fetch data from a website, your program makes a carefully-constructed HTTP request to the server the site is stored on. The server, in turn, sends you data in a format your program expects (if you asked for data) or incorporates your changes to the website (if you sent data). Your program now has a tasty chunk of data to use and you can use it to make diagrams/search for specific items/look at a user’s history/edit that wiki page/automatically bookmark those “to-watch” fanvids.

That’s it. A web API is just another way of exchanging information with a website. This web API description on Wikipedia is still full of acronyms… but it might make more sense now.

In the next post I’ll talk about how you can figure out how to make requests from an unfamiliar API.

This summer I’m taking part in the Outreach Program for Women, working on making the MediaWiki API more usable. As a part of this, I’ll be blogging every week or two with things I’ve done, things I’ve learned, or general thoughts as I get into the free/open source software world.

When my mentor mentioned that she had a project that could use an intern, I was not 100% clear on what an API (Application Programming Interface) was. I knew it had something to do with another way to interact with websites without actually having to visit the relevant webpages, but I’d never given it much thought.

I was interested, though. I went off for some quality research time and about ten days later I’d finished the project proposal for my OPW application.

Don’t believe anyone who tells you learning to code is easy…

…and don’t believe anyone who tells you that APIsespecially MediaWiki’sare intuitive.

As I gear up for WikiConference2014 next weekend, I’ll post resources I found helpful and tips for getting started yourself.

I wrote about the ways toxic entitlement enables unintentional but substantial harm in STEM communities for Model View Culture’s current issue, Abuse.

When “I Didn’t Mean To” Makes it Worse

Entitlement and violation in STEM communities

We assume that our stories are universal. We assume that what helps us will help others. We ask, “Couldn’t you just…?” and explain that, actually, if they saw things our way they’d have it better. We ignore differences of ability, power, class, and culture to overwrite their stories with ours. We expect the world to be as we want it, and when we have power we act like that’s true.

That is the danger of entitlement. When we expect more than we’re due, we are in danger of robbing those around us of their own autonomy. Our assumptions shape our actions. Unintentional harm becomes easy. When we don’t expect boundaries to exist, we step right past them without looking, all in what we think is good will.

We don’t want to do this. How do we stop?

I’ve written about my choice to leave the field of chemistry in Model View Culture’s Lean Out issue.

I Didn’t Want To Lean Out

Why I Left, How I Left, and What It Would Have Taken to Keep Me in STEM

When I decided to leave, I let go of my intention to continue contributing to the advancement of human knowledge as a scientist and a chemist. I mourned that I would not achieve my goal of changing the culture of organic chemistry, and I knew that my leaving would mean one less woman for other women to talk to, network with, and lean on for professional support. I fought feelings of obligation and squashed that nagging sense that I was letting down The Sisterhood™.

I was furious. I saw that little about my situation was fair, but there it was, and there I was.

In the end, I chose my own health and happiness and I chose self-respect.

You can find the rest here.