Git Product home page Git Product logo

bechdel-test's Introduction

bechdel.io

Find out if your favorite film passes the test

deps Coverage Status Build Status Maintainability stars pr license twitter bch compliance first-timers-only

The Bechdel Test, sometimes called the Mo Movie Measure or Bechdel Rule is a simple test which names the following three criteria:

  1. It includes at least two women
  2. who have at least one conversation
  3. about something other than a man or men.

The test was popularized by Alison Bechdel's comic Dykes to Watch Out For, in a 1985 strip called The Rule. For a nice video introduction to the subject please check out The Bechdel Test for Women in Movies on feministfrequency.com.

This program accepts a movie script and analyzes whether or not it passes the Bechdel Test, as well as analyzing several other feminist components to a film. It can answer questions like "How many females are in this film," "By what factor does this pass the Bechdel Test?"

Prerequisites

Quickstart:

1. Clone The Repository

git clone https://github.com/JoeKarlsson/bechdel-test
cd bechdel-test

2. Get API Keys For The MovieDB and My API Films

You will need to get API Keys for The MovieDB and My API Films.

3. Log on to Atlas

To use MongoDB Atlas, you must be logged into Atlas.

4. Create an Atlas Cluster

  1. In the left navigation pane, click Clusters, and then click the Build New Cluster button. The Create New Cluster page opens.
  2. Choose your preferred provider and region, tier, and additional settings. As you build your cluster, Atlas displays the associated costs at the bottom of the page.
  3. The default cluster name is Cluster0. If you wish to change the name, do so now, as cluster names cannot be changed once configured.
  4. Click the Create Cluster button to save your changes.

5. Configure Your Atlas Cluster

  1. Go to Database Access and hit Add New User. Add a username and password, if you autogenerate a password make sure you copy it, we’ll need it later.
  2. Go to Network Access, hit Add IP Address, and hit Add Current IP Address, then confirm.
  3. Go to Clusters, if your cluster build is done then hit Connect, Connect Your Application, and copy the line of code it gives you

6. Connect Bechdel.io to MongoDB and the various other APIs

Change src/server/config/config_example.json to src/server/config/config.json and

  • Paste your MongoDB URI into the MONGODB_URI feild.
  • Paste your MovieDB API Key into the THEMOVIEDB feild.
  • Paste your My API Films API Key into the MYAPIFILMS feild.

7. Install dependencies & run locally

npm install
npm start # open http://localhost:3000 in your browser

Testing

The bechdel.io test suite is run with npm test. You can read more about testing bechdel.io.

Where to Get Movie Scripts?

If you are looking to get your hands on some movie scripts to test, you can check out my CLI Movie Script Grabber https://github.com/JoeKarlsson/movie-script-scraper

Introduction

The Bechdel Test Script Parser was a collaborative digital humanities project between myself and my sister, Laurel Karlsson. It is the product of a shared passion for film, feminism, and the creative potential of technology. By combining the talents and interests of myself, a software engineer, we’ve been able to create an innovative data mining tool for film analysis that we hope to continue to work on and improve. You can check out the project on our website.

This project was born when my sister reached out to me for advice on a few ideas she had been mulling over for a digital humanities project. Hoping to do something related to feminist film analysis, she was feeling very limited by my lack of coding experience and hadn’t been able to find an existing data mining tool to accomplish what she was looking to do. I immediately offered up my coding expertise, looking to gain experience by building a tool from scratch which would accomplish the specific needs of the project. After brainstorming several different project ideas, we settled on the one you see here.

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

TLDR;

  1. Fork it!
  2. Create your feature branch: git checkout -b my-new-feature
  3. Commit your changes: git commit -am 'Add some feature'
  4. Push to the branch: git push origin my-new-feature
  5. Submit a pull request :D

Maintainers


Joe Karlsson

Laurel Karlsson

License

Related Links

Resources

bechdel-test's People

Contributors

dependabot[bot] avatar greenkeeper[bot] avatar joekarlsson avatar lukasnord avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar

bechdel-test's Issues

Search

Add search bar to header and make it easy to find any film you are looking for.

Possible third party integrations are possible, but this could be potentially done all with code.

Refactor Film.js:Film.renderFilm

I've selected Film.js:Film.renderFilm for refactoring, which is a unit of 47 lines of code. Addressing this will make our codebase more maintainable and improve Better Code Hub's Write Short Units of Code guideline rating! 👍

Here's the gist of this guideline:

  • Definition 📖
    Limit the length of code units to 15 lines of code.
  • Why
    Small units are easier to analyse, test and reuse.
  • How 🔧
    When writing new units, don't let them grow above 15 lines of code. When a unit grows beyond this, split it in smaller units of no longer than 15 lines.

You can find more info about this guideline in Building Maintainable Software. 📖


ℹ️ To know how many other refactoring candidates need addressing to get a guideline compliant, select some by clicking on the 🔲 next to them. The risk profile below the candidates signals (✅) when it's enough! 🏁


Good luck and happy coding! :shipit: ✨ 💯

Refactor URLFormatter.js:createSimpleDataURL

I've selected URLFormatter.js:createSimpleDataURL for refactoring, which is a unit of 34 lines of code. Addressing this will make our codebase more maintainable and improve Better Code Hub's Write Short Units of Code guideline rating! 👍

Here's the gist of this guideline:

  • Definition 📖
    Limit the length of code units to 15 lines of code.
  • Why
    Small units are easier to analyse, test and reuse.
  • How 🔧
    When writing new units, don't let them grow above 15 lines of code. When a unit grows beyond this, split it in smaller units of no longer than 15 lines.

You can find more info about this guideline in Building Maintainable Software. 📖


ℹ️ To know how many other refactoring candidates need addressing to get a guideline compliant, select some by clicking on the 🔲 next to them. The risk profile below the candidates signals (✅) when it's enough! 🏁


Good luck and happy coding! :shipit: ✨ 💯

first-timers-only-typo-in-copy "suppports" is spelled wrong, it should be "supports

🆕🐥☝ First Timers Only.

This issue is reserved for people who never contributed to Open Source before. We know that the process of creating a pull request is the biggest barrier for new contributors. This issue is for you 💝

About First Timers Only.

🤔 What you will need to know.

Nothing. This issue is meant to welcome you to Open Source :) We are happy to walk you through the process.

📋 Step by Step

  • 🙋 Claim this issue: Comment below.

    Once claimed we add you as contributor to this repository.

  • 👌 Accept our invitation to this repository. Once accepted, assign yourself to this issue

  • 📝 Update the file src/app/films/NewFilm/NewFilm.js in the bechdel-test repository (press the little pen Icon) and edit the line as shown below.

@@ -10,7 +10,7 @@ const NewFilm = () => {
 				<Uploader />
 			</ErrorBoundary>
 			<p>
-				Note: This tool currently only suppports scripts with a .txt format, and
+				Note: This tool currently only supports scripts with a .txt format, and
 				the script must follow the{' '}
 				<a target="blank" href="http://www.simplyscripts.com/WR_format.html">
 					Standard Script Format
  • 💾 Commit your changes

  • 🔀 Start a Pull Request. There are two ways how you can start a pull request:

  1. If you are familiar with the terminal or would like to learn it, here is a great tutorial on how to send a pull request using the terminal.

  2. You can edit files directly in your browser

  • 🏁 Done Ask in comments for a review :)

🤔❓ Questions

Leave a comment below!

This issue was created by First-Timers-Bot.

Install Babel

Need to install Babel so I can use fancy new ES6 and ES7 stuff.

Version 10 of node.js has been released

Version 10 of Node.js (code name Dubnium) has been released! 🎊

To see what happens to your code in Node.js 10, Greenkeeper has created a branch with the following changes:

  • Added the new Node.js version to your .travis.yml
  • The engines config in 1 of your package.json files was updated to the new Node.js version

If you’re interested in upgrading this repo to Node.js 10, you can open a PR with these changes. Please note that this issue is just intended as a friendly reminder and the PR as a possible starting point for getting your code running on Node.js 10.

More information on this issue

Greenkeeper has checked the engines key in any package.json file, the .nvmrc file, and the .travis.yml file, if present.

  • engines was only updated if it defined a single version, not a range.
  • .nvmrc was updated to Node.js 10
  • .travis.yml was only changed if there was a root-level node_js that didn’t already include Node.js 10, such as node or lts/*. In this case, the new version was appended to the list. We didn’t touch job or matrix configurations because these tend to be quite specific and complex, and it’s difficult to infer what the intentions were.

For many simpler .travis.yml configurations, this PR should suffice as-is, but depending on what you’re doing it may require additional work or may not be applicable at all. We’re also aware that you may have good reasons to not update to Node.js 10, which is why this was sent as an issue and not a pull request. Feel free to delete it without comment, I’m a humble robot and won’t feel rejected 🤖


FAQ and help

There is a collection of frequently asked questions. If those don’t help, you can always ask the humans behind Greenkeeper.


Your Greenkeeper Bot 🌴

Refactor helper.js:containsPatriarchalKeywords

I've selected helper.js:containsPatriarchalKeywords for refactoring, which is a unit of 54 lines of code. Addressing this will make our codebase more maintainable and improve Better Code Hub's Write Short Units of Code guideline rating! 👍

Here's the gist of this guideline:

  • Definition 📖
    Limit the length of code units to 15 lines of code.
  • Why
    Small units are easier to analyse, test and reuse.
  • How 🔧
    When writing new units, don't let them grow above 15 lines of code. When a unit grows beyond this, split it in smaller units of no longer than 15 lines.

You can find more info about this guideline in Building Maintainable Software. 📖


ℹ️ To know how many other refactoring candidates need addressing to get a guideline compliant, select some by clicking on the 🔲 next to them. The risk profile below the candidates signals (✅) when it's enough! 🏁


Good luck and happy coding! :shipit: ✨ 💯

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.