ical2csv-fork/README.md

76 lines
3.2 KiB
Markdown
Raw Normal View History

# ical2csv w/sorted events by start date
2019-10-30 18:02:12 +01:00
![alt text](images/ics.png) → ![alt text](images/python.png) → ![alt text](images/csv.png)
A command line Python script that will read an ics file and write it's contents to a csv file.
## Installation
Download the `ical2csv.py` file.
### Dependencies:
2016-02-04 23:43:59 +01:00
* ***icalendar***
* [**Homepage**](http://icalendar.readthedocs.org/)
* [**Code**](http://github.com/collective/icalendar)
2019-10-30 18:02:12 +01:00
* **Installation**: `pip install icalendar`
* ***Python* 3**
***Note:*** pip may be called pip3 on some systems with both python2 and python3 as options.
## Usage of ical2csv
Call the script and pass in the location of the ics file.
Ex: `python ical2csv.py event.ics`
# ical2txt w/sorted events by start date
Like ical2csv.py, it parses an ics file and writes the output to a text-file. This is more of an agenda style.
## Installation of ical2txt
Download the script or clone the project and get it from there.
### Dependencies for ical2txt
* ***setuptools*** (just in case : pip3 install setuptools)
* ***BeautifulSoup4*** (pip3 install beautifulsoup4)
* ***icalendar*** (pip3 install icalendar)
* [**Homepage**](http://icalendar.readthedocs.org/)
* [**Code**](http://github.com/collective/icalendar)
## Usage of ical2txt
2019-10-30 18:02:12 +01:00
Call the script and pass in the location of the ics file.
Ex: `python ical2txt.py event.ics` / `python3 ical2txt.py event.ics`
2019-10-30 18:02:12 +01:00
## Contributing
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 😊
## Credits
Lead Developer - ical2csv - [Erik Cox](https://github.com/erikcox/)
Developer - ical2txt - [Martin Møller](https://github.com/martinm76)
2019-10-30 18:02:33 +01:00
2019-10-30 18:10:18 +01:00
Python 3 compatibility and improvements - [bozoslivehere](https://github.com/bozoslivehere/)
Logic and adjustments to sort events chronologically (Google Calendar doesn't do this in its export) - [Martin Møller](https://github.com/martinm76)
Removal of HTML code from events (currently only ical2txt) - [Martin Møller](https://github.com/martinm76)
2019-10-30 18:02:12 +01:00
## License
The MIT License (MIT)
Copyright (c) 2019 Erik Cox
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.