Read the official documentation.
This export tool allows you to export GitHub projects as a CSV.
Projects must exist within the ProjectV2 API. For exporting "classic" GitHub projects (older implementation), you can try using this exporter by Stephen Wu.
- โฌ๏ธ Export all GitHub project cards as a CSV.
- View your GitHub cards in your spreadsheet software of choice.
- ๐๏ธ Filter issues by status, customize fields, and exclude closed issues.
- Only export cards with the statuses you specify, with options to choose custom fields, or hide closed issues.
- ๐ Easy to use
- Features a simple and easy to use web UI. Configure once. Click once to export.
I hope this project makes your life a little easier! If it does and you'd like to show your appreciation, consider supporting the project with a coffee or sponsorship.
Your support helps keep the project going and will earn you some serious virtual high fives. Maybe even a virtual fist bump if you're feeling extra cool.
- โ Open The GitHub Project Exporter โ
- Documentation
- Overview
- Donate
- Table of Contents
- Installation
- Usage
- TypeScript
- Icon Attribution
- Contributing
- โญ Found It Helpful? Star It!
- License
npm i github-projectv2-csv-exporter
Go here: GitHub Project Exporter.
If you want to fetch the data yourself, you can install this package via npm and use the exported fetch functions.
Note: Your access token must include the following scopes:
repo
,read:org
,read:user
,read:project
fetchProjects = async (login: string, isOrg: boolean, token: string): Promise<Projects>
Provide an org or username and the token. The promise will be resolved with a Projects
instance.
import { fetchProjects } from 'github-projectv2-csv-exporter';
// ...
fetchProjects('my-org', true, 'abc123mytoken').then((orgProjects) =>
console.log(
'Loaded projects:',
orgProjects
.getProjects()
.map((p) => `${p.getTitle()} (number ${p.getProjectNumber()} | ${p.getTotalItemCount()} items)`)
.join(', '),
),
);
fetchProjectItems = async (login: string, isOrg: boolean, projectNumber: number, token: string, progress?: (loaded: number, total: number) => void): Promise<ProjectItem[]>
Provide an org or username, project number, and token. Optionally, you can provide a progress
function that will be called periodically with the number of items loaded, and the total expected.
The promise will be resolved with an array of ProjectItem
instances.
import { fetchProjectItems } from 'github-projectv2-csv-exporter';
// ...
const projectNumber = loadedProject.getProjectNumber();
fetchProjectItems('my-org', true, projectNumber, 'abc123mytoken', (loaded, total) =>
console.log(`Progress: ${Math.round((loaded / total) * 100)}%`),
).then((items) => console.log('Loaded', items.length, 'items'));
Type definitions have been included for TypeScript support.
Favicon by Twemoji.
Open source software is awesome and so are you. ๐
Feel free to submit a pull request for bugs or additions, and make sure to update tests as appropriate. If you find a mistake in the docs, send a PR! Even the smallest changes help.
For major changes, open an issue first to discuss what you'd like to change.
โญ Found It Helpful? Star It!
If you found this project helpful, let the community know by giving it a star: ๐โญ
See LICENSE.md.